For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

put
Authorizations
AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters
roleIdstringRequiredPattern: ^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}$
Body

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.

roleNamestring · min: 1 · max: 255Optional
statusstring · enumOptionalPossible values:
userIdsstring[]Optional
Responses
200

Successful response.

application/json
put/v1/roles/{roleId}
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?