بروزرسانی گروه (Put, Update Role)
برای بهروزرسانی اطلاعات یک گروه استفاده میشود.
اطلاعات عمومی
- آدرس:
/api/v2/wallet-restriction/role
- متد:
PUT
- نوع محتوا:
application/json
- احراز هویت: نیازمند token
احراز هویت
- این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.
پارامترهای درخواست
درخواست باید شامل اطلاعات زیر در بدنه (body) باشد:
فیلد | نوع داده | ضروری | توضیحات |
---|---|---|---|
role | object | بله | اطلاعات نقش برای بهروزرسانی |
نمونه درخواست
curl --location --request PUT 'https://corporate.snapp.site/api/v2/wallet-restriction/role' \
--header 'Authorization: <your_authorization_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"role": {
"id": 123,
"title": "updated role"
}
}'
پاسخ موفق
{
"status": "success",
"data": {
"id": 123,
"title": "updated role"
}
}
فیلد | نوع داده | توضیحات |
---|---|---|
status | string | وضعیت پاسخ (success در صورت موفقیت) |
data | object | اطلاعات نقش بهروزرسانیشده |
├── id | integer | شناسه نقش |
├── title | string | عنوان نقش |
خطاها
کد وضعیت | توضیحات |
---|---|
400 | درخواست نامعتبر |
401 | نیاز به احراز هویت |
403 | دسترسی غیرمجاز |
500 | خطای داخلی سرور |
توضیحات تکمیلی
- این API اطلاعات نقش موردنظر را بهروزرسانی کرده و محدودیتهای جدید را روی آن اعمال میکند.
- در صورت عدم ارسال
restrictions
، محدودیتهای قبلی نقش باقی خواهند ماند.