Create a custom role

Create a custom role that can be set on users.

POST/api/v1/{team_slug}/{app_slug}/custom-roles

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/custom-roles

Create a custom role that can be set on users.

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: POST
Path: /api/v1/\{team_slug\}/\{app_slug\}/custom-roles
Summary: Create a custom role
Description: Create a custom role that can be set on users.
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug

Request bodyDocumented body

Required: Yes
Description: custom role details
Content: application/json (object)

Input Custom Role

Property	Type	Required	Details
`is_default`	boolean	No	-
`name`	string	Yes	-
`slug`	string	Yes	-

Generated example (synthetic):

{
  "is_default": false,
  "name": "string",
  "slug": "string"
}

Responses5 statuses

Status	Description	Content
200	custom role created successfully	application/json (object)
400	Invalid request (e.g. bad payload, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
409	Conflict (e.g. already exists)	application/json (object)
500	Internal server error	application/json (object)

200 - object

Custom Role Response

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Custom Role

Property	Type	Required	Details
`app_id`	string	No	-
`created_at`	string	No	-
`id`	string	No	-
`is_default`	boolean	No	-
`name`	string	No	-
`slug`	string	No	-
`updated_at`	string	No	-

Generated example (synthetic):

{
  "data": {
    "app_id": "string",
    "created_at": "string",
    "id": "string",
    "is_default": false,
    "name": "string",
    "slug": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

409 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: POST
Path: /api/v1/\{team_slug\}/\{app_slug\}/custom-roles
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: CustomRoles
OpenAPI summary: Create a custom role