Skip to main content
POST
Provision a customer

Authorizations

X-API-KEY
string
header
required

Your partner API key, pk_…. Backend only.

Body

application/json
external_id
string
required

Your own id for the customer. Use something that never changes.

Maximum string length: 255
Example:

"dealer-4821"

email
string<email>
required
Maximum string length: 255
Example:

"sales@acmemotors.test"

name
string
Maximum string length: 255
Example:

"Acme Motors"

Response

Provisioned

success
boolean
Example:

true

message
string
Example:

"User provisioned successfully."

data
object