Update Role
Change the supplied settings of a Tier 1 account role. Omitted fields retain their current values; at least one field must be supplied.
Assignments are a complete replacement when userIds is supplied. Include every user who should remain assigned. Send an empty array to remove all assignments or omit userIds to preserve them. Submitted users must belong to the same account.
A supplied permissions array also replaces the current permission list. The response contains the updated role detail.
Requires the roles:write scope.
API key sent as a bearer token (mk_live_… / mk_test_…).
^ROLE-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Data schema used by Update Role (PUT /v1/roles/{roleId}). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.
Successful response.
Invalid request data.
Missing or invalid API key.
The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).
Resource not found.
The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.
Internal server error.
PUT /v1/roles/{roleId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"roleName": "text",
"status": "ACTIVE",
"permissions": [
"CONTACTS_VIEW"
],
"userIds": [
"text"
]
}{
"data": {
"roleId": "text",
"roleName": "text",
"status": "ACTIVE",
"permissions": [
"text"
],
"userIds": [
"text"
],
"createdAt": "text",
"modifiedAt": "text"
}
}Last updated
Was this helpful?