/roles/{role}

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

x-account-id header string

Account ID for the request

role path string

The role name to create

Click here to view an exhaustive list of all available parameters

accountId query string

Account ID (required for SuperAdmin when operating on specific accounts)

Output:

Role successfully created

{
  "message": "admin role added to account: acct_123"
}

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

Check out the source code for this route entrypoint here: /roles/[role]/route.ts

Or the swagger.yaml spec this documentation was generated from: /roles/swagger.yaml