Skip to main content
POST
Create client

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Headers

Idempotency-Key
string
required

Unique key for this operation. Retry with the same key and request body after a timeout. Keys are retained for at least 24 hours.

Required string length: 1 - 255

Body

application/json
name
string

Client name. Supply this with web_address.

Minimum string length: 1
web_address
string

Client Entendre subdomain slug. Supply this with name.

Pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
contact_name
string | null

Client contact name.

contact_email
string<email> | null

Client contact email.

website
string<uri> | null

Client public website.

timezone
string

Client timezone.

Response

Created.

data
object
required