Skip to main content
POST
Create a client

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Body

application/json
slug
string
required

Lowercase letters, digits and dashes. Unique within the organization.

companyName
string
required

The customer's name.

websiteUrl
string

Their website.

generalSlackChannelId
string

A default channel id for this Client.

Response

Success.

data
object
required