Chat icon

Chat

Interact with the Chat API

Actions253

Custom Role → Update

AI-generated

Summary

Update an existing custom role by specifying the account and custom role to update, then setting its name, description, and/or permissions.

Inputs

  • accountId (required) — The account containing the custom role to update. Select from list or provide ID.
  • customRoleId (required) — The custom role to update. Select from list or provide ID.
  • updateFields.name — New name for the custom role.
  • updateFields.description — New description for the custom role.
  • updateFields.permissions — Permissions to grant to the custom role (multi-select).

Output shape

The updated custom role object as returned by the Approach API, containing at least the id, name, description, and permissions.

The operation returns the full updated custom role record.

Examples

Example 1: Rename a custom role and update its permissions

Set accountId to the desired account, customRoleId to the role to update, then in Update Fields set Name to 'New Role Name' and Permissions to include 'contact_manage' and 'conversation_manage'.

Links

Discussion