Create customer - API Reference

Request

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Body Params application/json

merchantCustomerId

string

required

>= 1 characters<= 128 characters

firstName

string | null

optional

<= 128 characters

lastName

string | null

optional

<= 128 characters

userName

string | null

optional

<= 128 characters

description

string | null

optional

<= 256 characters

email

string <email> | null

optional

dragonTermsAccepted

boolean

optional

Example

{
    "merchantCustomerId": "string",
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "description": "string",
    "email": "[email protected]",
    "dragonTermsAccepted": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.zen.com/v3/customers' \
--header 'request-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantCustomerId": "string",
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "description": "string",
    "email": "[email protected]",
    "dragonTermsAccepted": true
}'

Responses

🟢200OK

application/json

OK

Body

id

string <uuid>

required

merchantCustomerId

string

required

>= 1 characters<= 128 characters

status

enum<string>

required

Allowed values:

newconfirmed

firstName

string

optional

<= 128 characters

lastName

string

optional

<= 128 characters

userName

string

optional

<= 128 characters

description

string

optional

<= 256 characters

email

string <email>

optional

dragonTermsAccepted

boolean

required

createdAt

string <date-time>

required

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantCustomerId": "string",
    "status": "new",
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "description": "string",
    "email": "[email protected]",
    "dragonTermsAccepted": true,
    "createdAt": "2019-08-24T14:15:22Z"
}

🟠404Record Not Found