Skip to main content
POST
/
api
/
v2
/
clients
Create client
curl --request POST \
  --url https://api.example.com/api/v2/clients \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "emailAddress": "jsmith@example.com",
  "title": "<string>",
  "companyName": "<string>",
  "telephoneNumber": "<string>",
  "address": {
    "line_1": "<string>",
    "postcode": "<string>",
    "line_2": "<string>",
    "line_3": "<string>",
    "post_town": "<string>",
    "county": "<string>",
    "uprn": "<string>"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "firstName": "<string>",
  "lastName": "<string>",
  "emailAddress": "jsmith@example.com",
  "title": "<string>",
  "middleName": "<string>",
  "companyName": "<string>",
  "telephoneNumber": "<string>",
  "altTelephoneNumber": "<string>",
  "pronouns": "<string>",
  "communicationPreferences": {
    "email": true,
    "phone": true,
    "sms": true,
    "post": true
  },
  "avatarUrl": "<string>",
  "dob": "<string>",
  "nationality": "<string>",
  "niNumber": "<string>",
  "occupation": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "line_3": "<string>",
    "post_town": "<string>",
    "county": "<string>",
    "postcode": "<string>",
    "uprn": "<string>"
  }
}

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

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

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

Client's postal address