Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Body

application/json

Create Contact Request

email
string<email>
required

The contact's email address

full_name
string | null

The contact's name

phone_number
string | null

The contact's phone number

tax_id
string | null

The contact's tax ID

Maximum string length: 30
company_registration_number
string | null

The contact's company registration number

Maximum string length: 30
type
enum<string> | null

The type of contact

Available options:
domestic,
company,
student,
charity,
local_authority
source
enum<string> | null

The source of the contact data

Available options:
pre_open,
incomplete_booking,
registered_interest,
price_interest,
quotation_request,
booking,
popup,
external_enquiry,
phone,
walkin,
import,
other
marketing_source
enum<string> | null

What channel did the contact find us through

Available options:
used_before,
recommendation,
received_leaflet,
seen_building_signs,
seen_advert,
facebook_marketplace,
google_search,
other_online_search,
social_media,
email,
radio,
other
use_case
enum<string> | null

Why does the contact require storage

Available options:
business_needs,
moving_home,
more_space,
refurb,
travelling,
other
address
object | null

Address

metadata
object | null

Set of key-value pairs for storing additional information on the contact. Learn more about metadata.

Response

contact successfully created (minimal)

Single Contact

contact
object

Contact

meta
object