Skip to main content
POST
Register API consumer

Authorizations

Authorization
string
header
required

Platform token required for authentication. Find or create one inside Profile Icon > API Keys. Example: Bearer sk-agencii-...

Body

application/json
apiIntegrationId
string
required
externalUserId
string
required

A stable user ID from your application. It is stored as a hash.

Maximum string length: 512
displayName
string
Maximum string length: 256
email
string<email>
Maximum string length: 320

Response

Existing consumer returned.

consumerId
string
required
active
boolean
required
canStartRun
boolean
required

False when access is disabled or the current period is exhausted.

period
object
required
created
boolean
required