Team Management

Update Custom Role

Updates a custom role's permission matrix. Every category is at least 'view' — omitted categories default to 'view'. System roles cannot be edited. The new matrix must not duplicate an existing role's. Requires a global API key.

patch/api/v1/roles/{role_id}

Request

  • Base URL
    https://api.athenahq.ai
  • Auth
    API key in header x-api-key

Request body

Response

Role updated successfully

successboolean required

Example response

{
  "success": true,
  "role": {
    "name": "Content Manager",
    "slug": "content-manager"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.