پرش به مطلب اصلی

بروزرسانی گروه (Put, Update Role)

برای به‌روزرسانی اطلاعات یک گروه استفاده می‌شود.


اطلاعات عمومی

  • آدرس: /api/v2/wallet-restriction/role
  • متد: PUT
  • نوع محتوا: application/json
  • احراز هویت: نیازمند token

احراز هویت

  • این درخواست نیاز به یک Authorization token دارد که باید در هدر ارسال شود.

پارامترهای درخواست

درخواست باید شامل اطلاعات زیر در بدنه (body) باشد:

فیلدنوع دادهضروریتوضیحات
roleobjectبلهاطلاعات نقش برای به‌روزرسانی

نمونه درخواست

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"
}
}
فیلدنوع دادهتوضیحات
statusstringوضعیت پاسخ (success در صورت موفقیت)
dataobjectاطلاعات نقش به‌روزرسانی‌شده
├── idintegerشناسه نقش
├── titlestringعنوان نقش

خطاها

کد وضعیتتوضیحات
400درخواست نامعتبر
401نیاز به احراز هویت
403دسترسی غیرمجاز
500خطای داخلی سرور

توضیحات تکمیلی

  • این API اطلاعات نقش موردنظر را به‌روزرسانی کرده و محدودیت‌های جدید را روی آن اعمال می‌کند.
  • در صورت عدم ارسال restrictions، محدودیت‌های قبلی نقش باقی خواهند ماند.