Operation

Create Role

POST/roles

Create a custom role with specific permissions. Roles let you control what users can do. Define a set of permissions (like `events.create`, `venues.read`, `orders.refund`) and then assign the role to users who need those capabilities. Common roles might include "Event Manager", "Box Office Staff", "Marketing", or "Finance".

When to use this

Setting up custom access levels for your team
Creating a read-only role for auditors
Defining roles that match your organisational structure

Headers

Idempotency-KeystringOptional: Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.

Body

Returns

Role created successfully

Errors

400: Bad Request - Invalid input
401: Unauthorized - Authentication required
403: Forbidden - Insufficient permissions
404: Not Found - Resource not found
500: Internal Server Error

Every error names its code and links to it. All error codes

Notes

Note

Permissions use the format `resource.action` (e.g., `events.create`) or `resource.action:scope` (e.g., `events.read:own`).

Tip

Start with minimal permissions and add more as needed-it's easier to grant access than to revoke it.

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Create roleconst role = await client.role.create({  name: 'New Role',  // Add other required fields});console.log(`Created role with ID: ${role.id}`);

Response 201

{
  "id": "rol_abc123",
  "organisationId": "org_xyz789",
  "name": "Event Manager",
  "description": "Manages events and related resources",
  "isDeleted": false,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T14:45:00Z",
  "permissions": [
    "events.*",
    "venues.read:all",
    "orders.read"
  ],
  "isSystemRole": false
}