Skip to main content
POST
Create client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Body

application/json

Request body used to create a client resource.

Request body used to create a client resource.

name
string
required

The name of the client.

Required string length: 1 - 255
Example:

"Acme Corporation"

description
string

Additional information describing the client.

Maximum string length: 1024
Example:

"A leading provider of road runner deterrents."

order
integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991
Example:

13

media
object[]

Media attachment commands for an owning resource.

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

Client resource returned by the API.