Skip to content
Documentation

Create role

POST
/api/v1/roles
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "role_permissions": [ "update_emails" ] }'

Creates a new role.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
required
string
role_permissions
required
Array<string>
Allowed values: update_emails add_remove_reorder_email_components add_remove_conditional_from_components add_remove_locales_from_emails create_emails delete_emails submit_for_approval publish_emails force_publish_emails convert_emails_to_draft update_library_images create_library_images delete_library_images access_all_projects update_projects create_projects delete_projects update_email_design_systems create_email_design_systems delete_email_design_systems manage_component_presets update_dynamic_content_profiles create_dynamic_content_profiles delete_dynamic_content_profiles update_personalization_tags create_personalization_tags delete_personalization_tags update_conditionals create_conditionals delete_conditionals update_link_tracking_profiles create_link_tracking_profiles delete_link_tracking_profiles create_connectors update_connectors delete_connectors create_html_exports create_json_exports create_connector_exports update_organization manage_billing manage_api_keys manage_organization_sso_settings view_audit_logs send_test_emails manage_test_lists update_users create_users delete_users update_ai_agents create_ai_agents delete_ai_agents access_ai_chat_copilot ai_background_build_agents trigger_ai_reviews generate_ai_images update_ai_reviewers create_ai_reviewers delete_ai_reviewers create_roles update_roles delete_roles create_brand_profiles update_brand_profiles delete_brand_profiles create_layouts update_layouts delete_layouts email_commenting create_workspaces update_workspaces delete_workspaces access_all_workspaces manage_workspace_access create_teams update_teams delete_teams access_all_teams manage_mcp_servers manage_feeds manage_review_groups manage_app_configuration manage_oauth_apps

Responses

Section titled “Responses”

201

Section titled “201”

Successful

Media typeapplication/json
object
id
required
integer
name
required
string
role_permissions
required
Array<string>
Allowed values: update_emails add_remove_reorder_email_components add_remove_conditional_from_components add_remove_locales_from_emails create_emails delete_emails submit_for_approval publish_emails force_publish_emails convert_emails_to_draft update_library_images create_library_images delete_library_images access_all_projects update_projects create_projects delete_projects update_email_design_systems create_email_design_systems delete_email_design_systems manage_component_presets update_dynamic_content_profiles create_dynamic_content_profiles delete_dynamic_content_profiles update_personalization_tags create_personalization_tags delete_personalization_tags update_conditionals create_conditionals delete_conditionals update_link_tracking_profiles create_link_tracking_profiles delete_link_tracking_profiles create_connectors update_connectors delete_connectors create_html_exports create_json_exports create_connector_exports update_organization manage_billing manage_api_keys manage_organization_sso_settings view_audit_logs send_test_emails manage_test_lists update_users create_users delete_users update_ai_agents create_ai_agents delete_ai_agents access_ai_chat_copilot ai_background_build_agents trigger_ai_reviews generate_ai_images update_ai_reviewers create_ai_reviewers delete_ai_reviewers create_roles update_roles delete_roles create_brand_profiles update_brand_profiles delete_brand_profiles create_layouts update_layouts delete_layouts email_commenting create_workspaces update_workspaces delete_workspaces access_all_workspaces manage_workspace_access create_teams update_teams delete_teams access_all_teams manage_mcp_servers manage_feeds manage_review_groups manage_app_configuration manage_oauth_apps
builtin
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "id": 12345,
  "name": "Admin",
  "role_permissions": [
    "update_emails"
  ],
  "builtin": false,
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}