Chat icon

Chat

Interact with the Chat API

Actions253

Custom Role → Create

AI-generated

Summary

Create a new custom role in the selected account.

Inputs

  • accountId (required) — Select the account to use.
  • name (required) — Name of the custom role.
  • additionalFields — Additional fields for the custom role, such as description and permissions.

Output shape

a single custom role object

Returns the created role, including its generated ID and any defined additional fields; optional fields may be omitted if not provided.

Examples

Example 1: Create a support role for the main site account.

Account: Main Site; Name: Support Agent; Additional Fields: Description='Tier‑2 ticket handling', Permissions=['contact_manage','campaign_manage'].

Example 2: Add a role with only name and permissions.

Account: Default list; Name: Analytics; Additional Fields: Permissions=['report_manage','dashboard_app_manage'].

Example 3: Create a role with description only.

Account: Any; Name: QA; Additional Fields: Description='Quality Assurance access'.

Links

Discussion