Skip to main content
POST
Create client

Body

application/json
firstName
string
required

First name

lastName
string
required

Last name

emailAddress
string<email>
required

Email address

title
string | null

Client's title (e.g. Mr, Mrs, Ms, Dr)

companyName
string | null

Company name (if applicable)

telephoneNumber
string | null

Phone number in E.164 format

address
object | null

Client's postal address

Response

Client created

A client record

id
string<uuid>
required

Client ID

firstName
string
required

First name

lastName
string
required

Last name

emailAddress
string<email>
required

Email address

status
enum<string>
required

Client status

Available options:
Active,
Closed,
Invited,
NotInvited,
SendFailed
title
string | null

Client's title (e.g. Mr, Mrs, Ms, Dr)

middleName
string | null

Middle name

companyName
string | null

Company name (if applicable)

telephoneNumber
string | null

Primary telephone number in E.164 format

altTelephoneNumber
string | null

Alternative telephone number in E.164 format

pronouns
string | null

Client's preferred pronouns

communicationPreferences
object | null

Communication channel preferences

avatarUrl
string | null

URL of the client's avatar image

dob
string | null

Date of birth

nationality
string | null

Nationality

niNumber
string | null

National Insurance number

occupation
string | null

Occupation

address
object | null

Client's postal address