Create custom roles

Bulk-creates custom roles. Successful entities are returned in data; per-item failures in errors keyed by name.

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

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

team_slugstringrequired

app_slugstringrequired

Request body

requiredapplication/json

custom_rolesCreateCustomRoleItem[]required

min items 1 · max items 20

Show properties

Array of CreateCustomRoleItem

slugstringrequired

namestringrequired

is_defaultboolean

Responses

201

Created (partial success possible)

dataCustomRole[]required

Show properties

Array of CustomRole

idUUIDrequired

slugstringrequired

namestringrequired

is_defaultbooleanrequired

created_atstring<date-time>required

updated_atstring<date-time> | null

errorsCustomRoleError[]required

Show properties

Array of CustomRoleError

namestring | null

idUUID | null

Show properties

Any of:

UUID

string<uuid>

null

null

messagestringrequired

400

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

401

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

403

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

500

Request-level failure

errorErrorBodyrequired

Show properties

messagestringrequired

detailsstring[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

team_slugpath*app_slugpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.enad.io/api/v2/string/string/custom-roles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "custom_roles": [
    {
      "slug": "string",
      "name": "string",
      "is_default": true
    }
  ]
}'

const response = await fetch("https://api.enad.io/api/v2/string/string/custom-roles", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"custom_roles\": [\n    {\n      \"slug\": \"string\",\n      \"name\": \"string\",\n      \"is_default\": true\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.enad.io/api/v2/string/string/custom-roles",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"custom_roles\": [\n    {\n      \"slug\": \"string\",\n      \"name\": \"string\",\n      \"is_default\": true\n    }\n  ]\n}",
)

Response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "slug": "string",
      "name": "string",
      "is_default": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "errors": [
    {
      "name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string"
    }
  ]
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}