Skip to content
Documentation

Update role

PATCH
/api/v1/roles/{id}

Updates a single role by ID.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
integer

Role ID

Request Body

Section titled “Request Body ”
object
name
string
role_permissions
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 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_exports update_organization manage_billing manage_api_keys manage_organization_sso_settings view_audit_logs send_test_emails update_users create_users delete_users update_ai_agents create_ai_agents delete_ai_agents 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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
name
required
string
Example
Admin
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 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_exports update_organization manage_billing manage_api_keys manage_organization_sso_settings view_audit_logs send_test_emails update_users create_users delete_users update_ai_agents create_ai_agents delete_ai_agents 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
builtin
required
boolean
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

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