Skip to main content
PUT
Update a client

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Object ID (UUID)

Body

application/json

Record of a single customer of your business. Create one for each of your clients.

email
string<email>
required

Email address

Maximum string length: 254
Example:

"customer@example.com"

bank_account
string

Bank account number (e.g. IBAN)

Maximum string length: 34
bank_code
string

SWIFT/BIC code of the bank

Maximum string length: 11
phone
string

Phone number in the <country_code> <number> format

Maximum string length: 32
Example:

"+60 123456789"

full_name
string

Name and surname of client. It is advisable to include full_name in request body.

Maximum string length: 128
personal_code
string

Personal identification code of client

Maximum string length: 32
street_address
string

Street house number and flat address where applicable

Maximum string length: 128
country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum string length: 2
city
string

City name

Maximum string length: 128
zip_code
string

ZIP or postal code

Maximum string length: 32
state
string

State code

Maximum string length: 128
shipping_street_address
string

Street house number and flat address where applicable

Maximum string length: 128
shipping_country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum string length: 2
shipping_city
string

City name

Maximum string length: 128
shipping_zip_code
string

ZIP or postal code

Maximum string length: 32
shipping_state
string

State code

Maximum string length: 128
cc
string<email>[]

Email addresses to receive a carbon copy of all notification emails

Email address

Maximum string length: 254
bcc
string<email>[]

Email addresses to receive a blind carbon copy of all notification emails

Email address

Maximum string length: 254

Legal name of company

Maximum string length: 128
brand_name
string

Company brand name

Maximum string length: 128
registration_number
string

Registration number of company

Maximum string length: 32
tax_number
string

Tax payer registration number

Maximum string length: 32

Response

OK

Record of a single customer of your business. Create one for each of your clients.

email
string<email>
required

Email address

Maximum string length: 254
Example:

"customer@example.com"

type
string

Object type identifier

id
string<uuid>
created_on
integer<int64>

Object creation time

Example:

1619740800

updated_on
integer<int64>

Object last modification time

Example:

1619740800

bank_account
string

Bank account number (e.g. IBAN)

Maximum string length: 34
bank_code
string

SWIFT/BIC code of the bank

Maximum string length: 11
phone
string

Phone number in the <country_code> <number> format

Maximum string length: 32
Example:

"+60 123456789"

full_name
string

Name and surname of client. It is advisable to include full_name in request body.

Maximum string length: 128
personal_code
string

Personal identification code of client

Maximum string length: 32
street_address
string

Street house number and flat address where applicable

Maximum string length: 128
country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum string length: 2
city
string

City name

Maximum string length: 128
zip_code
string

ZIP or postal code

Maximum string length: 32
state
string

State code

Maximum string length: 128
shipping_street_address
string

Street house number and flat address where applicable

Maximum string length: 128
shipping_country
string

Country code in the ISO 3166-1 alpha-2 format (e.g. 'GB')

Maximum string length: 2
shipping_city
string

City name

Maximum string length: 128
shipping_zip_code
string

ZIP or postal code

Maximum string length: 32
shipping_state
string

State code

Maximum string length: 128
cc
string<email>[]

Email addresses to receive a carbon copy of all notification emails

Email address

Maximum string length: 254
bcc
string<email>[]

Email addresses to receive a blind carbon copy of all notification emails

Email address

Maximum string length: 254

Legal name of company

Maximum string length: 128
brand_name
string

Company brand name

Maximum string length: 128
registration_number
string

Registration number of company

Maximum string length: 32
tax_number
string

Tax payer registration number

Maximum string length: 32