Create client
Clients
Create client
Creates a new client for the authenticated organisation.
POST
Create client
Body
application/json
First name
Last name
Email address
Client's title (e.g. Mr, Mrs, Ms, Dr)
Company name (if applicable)
Phone number in E.164 format
Client's postal address
Response
Client created
A client record
Client ID
First name
Last name
Email address
Client status
Available options:
Active, Closed, Invited, NotInvited, SendFailed Client's title (e.g. Mr, Mrs, Ms, Dr)
Middle name
Company name (if applicable)
Primary telephone number in E.164 format
Alternative telephone number in E.164 format
Client's preferred pronouns
Communication channel preferences
URL of the client's avatar image
Date of birth
Nationality
National Insurance number
Occupation
Client's postal address