Create a credential category

Credentials module

POST/credential-categoriescredentialCategories.create

A credential category, such as All Access or Artist. Creates a credential category. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability credentials.category.write.
OAuth scopes: credentials.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: CredentialCategoryCreate

credentialCategories.create: CredentialCategoryCreate
Field	Type	Required	Description
name	string	Yes	Category name.Constraints: length 1 to 300
project_id	string (uuid)	Yes	Identifier of the project.
code	string	Yes	Category code, unique per project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "name": "All Access",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "code": "ALL-ACCESS"
}

Response 201: CredentialCategory

credentialCategories.create: CredentialCategory
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the credential category.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Category name.Constraints: length 1 to 300
project_id	string (uuid)	Yes	Identifier of the project.
code	string	Yes	Category code, unique per project.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "All Access",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "code": "ALL-ACCESS"
}

Code samples

curl -X POST "$XOS_BASE_URL/credential-categories" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"All Access","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","code":"ALL-ACCESS"}'

const { data } = await xos.credentialCategories.create({
    "name": "All Access",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "code": "ALL-ACCESS"
  });

response = xos.credential_categories.create({"name": "All Access", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "code": "ALL-ACCESS"})

xos credential-categories create --data '{"name":"All Access","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","code":"ALL-ACCESS"}'