Create an organisation API key

POST/api-keys

Creates a long-lived key a partner server uses to call this API and to mint embed sessions. The key material is in this response once. Users only (requires apikeys.create).

Request Body

name*stringDisplay name for the key

scopes*string[]Scopes the key may exercise. One or more of: accounts.read, accounts.write, events.read, events.write, venues.read, venues.write, inventory.read, inventory.write, saleschannels.read, saleschannels.write, saleschannelkeys.write, orders.read, orders.write, customers.read, webhooks.read, webhooks.write

accountIdstringPin the key to one account (omit for every account in the organisation)

expiresAtstring,null (date-time)Optional expiry; the key stops authenticating after this instant

Response

API key created

Code Samples

No code examples available for this operation.

Try It

Request Body

name*Display name for the key

scopes*[ "accounts.write", "saleschannels.write", "saleschannelkeys.write", "events.write", "orders.read" ]Scopes the key may exercise. One or more of: accounts.read, accounts.write, events.read, events.write, venues.read, venues.write, inventory.read, inventory.write, saleschannels.read, saleschannels.write, saleschannelkeys.write, orders.read, orders.write, customers.read, webhooks.read, webhooks.write

accountIdPin the key to one account (omit for every account in the organisation)

expiresAtOptional expiry; the key stops authenticating after this instant