Operation
Update Account
PATCH
/accounts/{id}Update an account's details.
Change the account name, settings, or configuration. Only the fields you
include will be updated-everything else stays the same.
Account settings affect all events created within that account, so changes
here can have wide-reaching effects.
When to use this
- Renaming an account when a promoter rebrands
- Updating account settings or configuration
- Correcting account details after initial setup
Path parameters
idstringRequired- Account 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
namestringAccount name
status"active" | "inactive"Account status
Returns
Account 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
Changes to account settings may affect all events within that account.
Tip
Only send the fields you want to change-omitted fields stay the same.
Related
import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({ organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Update accountconst updated = await client.account.update('{{ACCOUNT_ID}}', { name: 'Updated Name', // Add fields to update});console.log(`Updated account: ${updated.name}`);Response 200
{
"account": {
"id": "acc_abc123",
"organisationId": "org_xyz789",
"name": "Main Account",
"status": "active",
"isDeleted": false,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-20T14:45:00Z"
}
}