Create Client

post

https://{api_url}/api/v5/admin/{company_id}/client

Creates a new client.

Recipes

👳

Create a Customer record

Open Recipe

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

Body Params

first_name

string

First name

first_name_extra

string

First name extra

last_name

string

Last name

last_name_extra

string

Last name extra

string

mobile_prefix

string

Mobile prefix

mobile

string

Mobile phone

mobile_prefix_country_code

string

Mobile Prefix Country Code

phone_prefix

string

Phone prefix

phone

string

Phone

phone_prefix_country_code

string

Phone Prefix Country Code

address1

string

Address1

address2

string

Address2

address3

string

Address3

address4

string

Address4

address5

string

Address5

postcode

string

Postcode

country

string

Country

member_type

int32

enum

Customer Type

Allowed:

member_level_id

int32

Member Level ID

mem_join_date

date

Client's Join Date in ISO-8601

time_zone

string

Time zone

consent

boolean

Consent for collecting and storing data

extra_info

object

comp_ref

string

default_company_id

string

The default company the client should belong to

reference

string

join_date

date

Client's Join Date in ISO-8601

send_email

string

Defaults to false

notification_preferences

object

Response

Language

Credentials

URL

Loading…

Response

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

application/json

200Client