Create a customer

post

https://public-api.deskday.ai/v1/customers

Create a customer. Requires scope customers:write. Supports X-Idempotency-Key.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

street

string

length ≤ 200

Street address line.

city

string

length ≤ 100

City or locality.

state

string

length ≤ 100

State, province, or region.

country

string

length ≤ 100

Country, ISO 3166-1 alpha-2 code preferred.

zip_code

string

length ≤ 20

Postal or ZIP code.

address_1

string

length ≤ 200

Primary address line.

address_2

string

length ≤ 200

Secondary address line, such as a suite or unit.

name

string

required

length between 1 and 200

Customer display name. Required.

string

required

length ≤ 254

Primary customer email address. Required.

domains

array of strings

length ≤ 64

Email domains associated with the customer.

domains

customer_type

string

enum

Customer classification; accepted case-insensitively (business or individual).

Allowed:

contact_number

string

length ≤ 50

Primary contact phone number.

timezone

string

length ≤ 64

IANA timezone identifier for the customer.

industry

string

length ≤ 100

Industry or sector of the customer.

external_ref

object

External system reference linking the customer to a third-party object.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201

400Validation failed or the request was malformed.

401Missing or invalid credentials (API key or M2M JWT).

403Authenticated, but the credential lacks the required scope.

409Conflict — e.g. a duplicate external_ref or an idempotency-key clash.

429Rate limit exceeded — retry after the window resets.

500Unexpected internal error. The request_id identifies the failure.