Skip to content
Docs
Open Backstage
Operation

Update Organisation

PATCH/organisations/{id}
Change your organisation's settings. Update the organisation name, branding, contact details, or other configuration options. Only admins can make these changes. Like other update endpoints, only send the fields you want to change.

When to use this

  • Updating the organisation name or branding
  • Changing contact information
  • Modifying organisation-wide settings

Path parameters

idstringRequired
Organisation ID

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

Organisation updated 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
Only users with admin permissions can update organisation settings.
Tip
Changes to branding may take a few minutes to propagate to all systems.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Update organisationconst updated = await client.organisation.update('{{ORGANISATION_ID}}', {  name: 'Updated Name',  // Add fields to update});console.log(`Updated organisation: ${updated.name}`);
Response 200
{
  "organisation": {
    "id": "org_xyz789",
    "name": "Acme Corporation",
    "primaryColor": "#FF5733",
    "secondaryColor": "#3366FF",
    "logoUrl": "https://example.com/logo.png",
    "metadata": {
      "industry": "Technology",
      "size": "Medium"
    },
    "apiVersion": "2026-10-02",
    "testMode": false,
    "allowApiKeyLedgerRead": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:45:00Z"
  }
}

Try it in test mode

Path parameters
Organisation ID