HighLevel: Contacts schemas

← Contacts operations · All schemas

Add Contact to Campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Optional	Whether the campaign operation was successful

Add Contact to Workflow — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
eventStartTime	string	Optional	Start time of the workflow event (ISO 8601 format)

Add Contact to Workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Optional	Whether the workflow operation was successful

Add Followers — contacts add Followers Contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
followers	array	Required within parent	List of user Ids to follow or unfollow the contact
followers[]	string	Each item

Add Followers — contacts add Followers Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
followers	array	Optional	Current followers after the operation
followers[]	string	Each item
followersAdded	array	Optional	Followers that were added
followersAdded[]	string	Each item

Add Remove Contacts From Business — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
businessId	JSON	Required within parent
businessId (anyOf 1)	string	Alternative	Business Id to assign to contacts. Pass null to remove business association.
businessId (anyOf 2)	null	Alternative
ids	array	Required within parent	List of contact Ids to update (maximum 50)
ids[]	string	Each item	Maximum length: 50
locationId	string	Required within parent	Location Id

Add Remove Contacts From Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
ids	array	Required within parent	List of contact Ids that were updated
ids[]	string	Each item
success	boolean	Required within parent	Whether the bulk update was successful

Add Tags — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
tags	array	Required within parent	List of tags to add or remove
tags[]	string	Each item

Add Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root
tags	array	Optional	Current tags on the contact after the operation
tags[]	string	Each item

Create Contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address1	JSON	Optional
address1 (anyOf 1)	string	Alternative	Street address of the contact
address1 (anyOf 2)	null	Alternative
assignedTo	string	Optional	User's Id
city	JSON	Optional
city (anyOf 1)	string	Alternative	City of the contact
city (anyOf 2)	null	Alternative
companyName	JSON	Optional
companyName (anyOf 1)	string	Alternative	Company name of the contact
companyName (anyOf 2)	null	Alternative
country	string	Optional	Country code of the contact (ISO 3166-1 alpha-2)
customFields	array	Optional	List of custom field values to assign to the contact
customFields[]	JSON	Each item
customFields[] (anyOf 1)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field
customFields[] (anyOf 2)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field
customFields[] (anyOf 3)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field
customFields[] (anyOf 4)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field
customFields[] (anyOf 5)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field
customFields[] (anyOf 6)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field
customFields[] (anyOf 7)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field
customFields[] (anyOf 8)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field
customFields[] (anyOf 9)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field
dateOfBirth	JSON	Optional
dateOfBirth (anyOf 1)	object	Alternative	The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
dateOfBirth (anyOf 2)	null	Alternative
dnd	boolean	Optional	Whether Do Not Disturb is enabled for the contact
dndSettings	JSON	Optional	Per-channel DND settings for the contact
dndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App
email	JSON	Optional
email (anyOf 1)	string	Alternative	Email address of the contact
email (anyOf 2)	null	Alternative
firstName	JSON	Optional
firstName (anyOf 1)	string	Alternative	First name of the contact
firstName (anyOf 2)	null	Alternative
gender	string	Optional	Gender of the contact
inboundDndSettings	JSON	Optional	Inbound DND settings per channel for the contact
inboundDndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body inbound Dnd Settings all
lastName	JSON	Optional
lastName (anyOf 1)	string	Alternative	Last name of the contact
lastName (anyOf 2)	null	Alternative
locationId	string	Required within parent	Location Id the contact should be created under
name	JSON	Optional
name (anyOf 1)	string	Alternative	Full name of the contact
name (anyOf 2)	null	Alternative
phone	JSON	Optional
phone (anyOf 1)	string	Alternative	Phone number of the contact
phone (anyOf 2)	null	Alternative
postalCode	string	Optional	Postal code of the contact
source	string	Optional	Source from which the contact was created
state	JSON	Optional
state (anyOf 1)	string	Alternative	State of the contact
state (anyOf 2)	null	Alternative
tags	array	Optional	List of tags to assign to the contact
tags[]	string	Each item
timezone	JSON	Optional
timezone (anyOf 1)	string	Alternative	Timezone of the contact
timezone (anyOf 2)	null	Alternative
website	JSON	Optional
website (anyOf 1)	string	Alternative	Website URL of the contact
website (anyOf 2)	null	Alternative

Referenced models: Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field, Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App, Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field, Create Contact — request body — body inbound Dnd Settings all, Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field

Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Field	Type	Presence	Description and constraints
$	object	Root
code	string	Optional	DND code or reason
message	string	Optional	Custom message associated with the DND setting
status	string	Required within parent	Do Not Disturb status for this channel One of: active, inactive, permanent

Create Contact — request body — body / inboundDndSettings / all / all / status: active, inactive

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Optional	Custom message associated with the inbound DND setting
status	string	Required within parent	Inbound DND status for this channel One of: active, inactive

Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	array	Optional	Array of selected checkbox values for the custom field (preferred).
fieldValue[]	string	Each item
field_value	array	Optional	Deprecated. Use `fieldValue` instead.
field_value[]	string	Each item
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	object	Optional	File upload value — a map of UUID to file metadata and download URL (preferred).
field_value	object	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	string	Optional	Large text value for the custom field (preferred).
field_value	string	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	object	Optional	Monetary value for the custom field (preferred).
field_value	object	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	array	Optional	Array of selected values for the custom field (preferred).
fieldValue[]	string	Each item
field_value	array	Optional	Deprecated. Use `fieldValue` instead.
field_value[]	string	Each item
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	object	Optional	Numeric value for the custom field (preferred).
field_value	object	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	string	Optional	Selected radio option value for the custom field (preferred).
field_value	string	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	string	Optional	Selected option value for the custom field (preferred).
field_value	string	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field

Field	Type	Presence	Description and constraints
$	object	Root
fieldValue	string	Optional	Text value for the custom field (preferred).
field_value	string	Optional	Deprecated. Use `fieldValue` instead.
id	string	Required within parent	Pass either `id` or `key` of custom field
key	string	Optional	Pass either `id` or `key` of custom field

Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App

Field	Type	Presence	Description and constraints
$	object	Root
call	JSON	Optional	DND settings for phone calls
call (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
email	JSON	Optional	DND settings for email
email (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
fb	JSON	Optional	DND settings for Facebook
fb (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
gmb	JSON	Optional	DND settings for Google My Business
gmb (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
sms	JSON	Optional	DND settings for SMS
sms (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
whatsApp	JSON	Optional	DND settings for WhatsApp
whatsApp (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Referenced models: Create Contact — request body — body / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Create Contact — request body — body inbound Dnd Settings all

Field	Type	Presence	Description and constraints
$	object	Root
all	JSON	Optional	Inbound DND settings applied to all channels
all (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body / inboundDndSettings / all / all / status: active, inactive

Referenced models: Create Contact — request body — body / inboundDndSettings / all / all / status: active, inactive

Create Note — contacts create Note — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Required within parent	Body content of the note
color	string	Optional	Hex color code for the note
pinned	boolean	Optional	Whether the note is pinned
title	string	Optional	Title of the note
userId	string	Optional	User Id of the note author

Create Task — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	User Id to whom the task is assigned
body	string	Optional	Body or description of the task
completed	boolean	Required within parent	Whether the task is completed
dueDate	string	Required within parent	Due date of the task (ISO 8601 format)
title	string	Required within parent	Title of the task

Delete Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Optional	Whether the delete operation succeeded

Delete Note — contacts delete Note — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Optional	Whether the note was successfully deleted

Delete Task — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Optional	Whether the task was successfully deleted

Get All Notes — response body

Field	Type	Presence	Description and constraints
$	object	Root
notes	array	Optional	List of notes
notes[]	Model	Each item	Expand Get All Notes — response body — notes item

Referenced models: Get All Notes — response body — notes item

Get All Notes — response body — notes item

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Optional	Body content of the note
color	string	Optional	Hex color code for the note
contactId	string	Optional	Contact Id associated with the note
dateAdded	string	Optional	Date the note was added (ISO 8601 format)
id	string	Optional	Unique identifier of the note
pinned	boolean	Optional	Whether the note is pinned
title	string	Optional	Title of the note
userId	string	Optional	User Id of the note author

Get Appointments for Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
events	array	Optional	List of appointments
events[]	Model	Each item	Expand Get Appointments for Contact — response body — events item

Referenced models: Get Appointments for Contact — response body — events item

Get Appointments for Contact — response body — events item

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Address for the appointment
appointmentStatus	string	Optional	Appointment status
assignedResources	array	Optional	List of resource Ids assigned to the appointment
assignedResources[]	string	Each item
assignedUserId	string	Optional	User Id assigned to the appointment
calendarId	string	Optional	Calendar Id associated with the appointment
contactId	string	Optional	Contact Id associated with the appointment
dateAdded	string	Optional	Date the appointment was created
dateUpdated	string	Optional	Date the appointment was last updated
endTime	string	Optional	End time of the appointment
groupId	string	Optional	Group Id of the appointment
id	string	Optional	Unique identifier of the appointment
locationId	string	Optional	Location Id of the appointment
notes	string	Optional	Notes for the appointment
startTime	string	Optional	Start time of the appointment
status	string	Optional	Status of the appointment
title	string	Optional	Title of the appointment
users	array	Optional	List of user Ids assigned to the appointment
users[]	string	Each item

Get Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
contact	JSON	Optional	Contact details
contact (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Referenced models: Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Field	Type	Presence	Description and constraints
$	object	Root
code	string	Optional	DND code or reason
message	string	Optional	Custom message associated with the DND setting
status	string	Required within parent	Do Not Disturb status for this channel Known values: active, inactive, permanent

Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Field	Type	Presence	Description and constraints
$	object	Root
address1	string	Optional	Street address of the contact
assignedTo	string	Optional	User Id the contact is assigned to
attachments	string	Optional	List of attachment URLs associated with the contact
attributionSource	JSON	Optional	First-touch attribution source details for the contact
attributionSource (allOf 1)	Model	All variants apply	Expand Get Contacts By Business Id — response body — contacts item attributions item
businessId	string	Optional	Business Id the contact is associated with
city	string	Optional	City of the contact
companyName	string	Optional	Company name of the contact
country	string	Optional	Country of the contact
customFields	array	Optional	List of custom field values for the contact
customFields[]	Model	Each item	Expand Get Contacts By Business Id — response body — contacts item custom Fields item
dateAdded	string	Optional	Date and time the contact was added (ISO 8601)
dateOfBirth	string	Optional	Date of birth of the contact (YYYY-MM-DD)
dateUpdated	string	Optional	Date and time the contact was last updated (ISO 8601)
dnd	boolean	Optional	Whether Do Not Disturb is enabled for the contact
dndSettings	JSON	Optional	Per-channel DND settings for the contact
dndSettings (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website dnd Settings call, email, fb, gmb, sms, whats App
email	string	Optional	Email address of the contact
emailLowerCase	string	Optional	Lowercase version of the contact email
firstName	string	Optional	First name of the contact
firstNameLowerCase	string	Optional	Lowercase version of the contact first name
fullNameLowerCase	string	Optional	Lowercase version of the contact full name
id	string	Optional	Unique identifier of the contact
keyword	string	Optional	Search keyword associated with the contact
lastActivity	string	Optional	Date and time of last activity on this contact (ISO 8601)
lastAttributionSource	JSON	Optional	Last-touch attribution source details for the contact
lastAttributionSource (allOf 1)	Model	All variants apply	Expand Get Contacts By Business Id — response body — contacts item attributions item
lastName	string	Optional	Last name of the contact
lastNameLowerCase	string	Optional	Lowercase version of the contact last name
locationId	string	Optional	Location Id the contact belongs to
name	string	Optional	Full name of the contact
phone	string	Optional	Phone number of the contact
postalCode	string	Optional	Postal code of the contact
source	string	Optional	Source from which the contact was created
ssn	string	Optional	Social Security Number (if applicable)
state	string	Optional	State of the contact
tags	array	Optional	List of tags associated with the contact
tags[]	string	Each item
timezone	string	Optional	Timezone of the contact
type	string	Optional	Contact type classification
visitorId	string	Optional	visitorId is the Unique ID assigned to each Live chat visitor.
website	string	Optional	Website URL of the contact

Referenced models: Get Contacts By Business Id — response body — contacts item attributions item, Get Contacts By Business Id — response body — contacts item custom Fields item, Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website dnd Settings call, email, fb, gmb, sms, whats App

Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website dnd Settings call, email, fb, gmb, sms, whats App

Field	Type	Presence	Description and constraints
$	object	Root
call	JSON	Optional	DND settings for phone calls
call (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
email	JSON	Optional	DND settings for email
email (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
fb	JSON	Optional	DND settings for Facebook
fb (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
gmb	JSON	Optional	DND settings for Google My Business
gmb (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
sms	JSON	Optional	DND settings for SMS
sms (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent
whatsApp	JSON	Optional	DND settings for WhatsApp
whatsApp (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Referenced models: Get Contact — response body — contact / address1, assignedTo, attachments, attributionSource, businessId, city, companyName, country, customFields, dateAdded, dateOfBirth, dateUpdated, dnd, dndSettings, email, emailLowerCase, firstName, firstNameLowerCase, fullNameLowerCase, id, keyword, lastActivity, lastAttributionSource, lastName, lastNameLowerCase, locationId, name, phone, postalCode, source, ssn, state, tags, timezone, type, visitorId, website / dndSettings / call, email, fb, gmb, sms, whatsApp / fb / status: active, inactive, permanent

Get Contacts By Business Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
contacts	array	Optional	List of contacts associated with the business
contacts[]	Model	Each item	Expand Get Contacts By Business Id — response body — contacts item
count	JSON	Optional
count (anyOf 1)	number	Alternative	Total number of contacts matching the query
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Contacts By Business Id — response body — contacts item

Get Contacts By Business Id — response body — contacts item

Field	Type	Presence	Description and constraints
$	object	Root
attributions	array	Optional	List of attribution sources for the contact
attributions[]	Model	Each item	Expand Get Contacts By Business Id — response body — contacts item attributions item
businessId	string	Optional	Business Id the contact is associated with
country	string	Optional	Country of the contact
customFields	array	Optional	List of custom field values for the contact
customFields[]	Model	Each item	Expand Get Contacts By Business Id — response body — contacts item custom Fields item
dateAdded	string	Optional	Date and time the contact was added (ISO 8601)
email	string	Optional	Email address of the contact
followers	array	Optional	List of user Ids following this contact
followers[]	string	Each item
id	string	Optional	Unique identifier of the contact
locationId	string	Optional	Location Id the contact belongs to
source	string	Optional	Source from which the contact was created
tags	array	Optional	List of tags associated with the contact
tags[]	string	Each item
timezone	string	Optional	Timezone of the contact

Referenced models: Get Contacts By Business Id — response body — contacts item attributions item, Get Contacts By Business Id — response body — contacts item custom Fields item

Get Contacts By Business Id — response body — contacts item attributions item

Field	Type	Presence	Description and constraints
$	object	Root
campaign	JSON	Optional
campaign (anyOf 1)	string	Alternative	Campaign name
campaign (anyOf 2)	null	Alternative
campaignId	JSON	Optional
campaignId (anyOf 1)	string	Alternative	Campaign Id
campaignId (anyOf 2)	null	Alternative
dclid	JSON	Optional
dclid (anyOf 1)	string	Alternative	DoubleClick click Id
dclid (anyOf 2)	null	Alternative
fbEventId	JSON	Optional
fbEventId (anyOf 1)	string	Alternative	Facebook event Id
fbEventId (anyOf 2)	null	Alternative
fbc	JSON	Optional
fbc (anyOf 1)	string	Alternative	Facebook browser Id
fbc (anyOf 2)	null	Alternative
fbclid	JSON	Optional
fbclid (anyOf 1)	string	Alternative	Facebook click Id
fbclid (anyOf 2)	null	Alternative
fbp	JSON	Optional
fbp (anyOf 1)	string	Alternative	Facebook pixel Id
fbp (anyOf 2)	null	Alternative
gclid	JSON	Optional
gclid (anyOf 1)	string	Alternative	Google click Id
gclid (anyOf 2)	null	Alternative
ip	JSON	Optional
ip (anyOf 1)	string	Alternative	IP address of the visitor
ip (anyOf 2)	null	Alternative
medium	JSON	Optional
medium (anyOf 1)	string	Alternative	Attribution medium (e.g. survey, funnel)
medium (anyOf 2)	null	Alternative
mediumId	JSON	Optional
mediumId (anyOf 1)	string	Alternative	Id of the attribution medium
mediumId (anyOf 2)	null	Alternative
msclikid	JSON	Optional
msclikid (anyOf 1)	string	Alternative	Microsoft click Id
msclikid (anyOf 2)	null	Alternative
referrer	JSON	Optional
referrer (anyOf 1)	string	Alternative	Referrer URL
referrer (anyOf 2)	null	Alternative
url	string	Required within parent	Attribution source type
userAgent	JSON	Optional
userAgent (anyOf 1)	string	Alternative	Browser user agent string
userAgent (anyOf 2)	null	Alternative
utmContent	JSON	Optional
utmContent (anyOf 1)	string	Alternative	UTM content parameter
utmContent (anyOf 2)	null	Alternative
utmMedium	JSON	Optional
utmMedium (anyOf 1)	string	Alternative	UTM medium parameter
utmMedium (anyOf 2)	null	Alternative
utmSource	JSON	Optional
utmSource (anyOf 1)	string	Alternative	UTM source parameter
utmSource (anyOf 2)	null	Alternative

Get Contacts By Business Id — response body — contacts item custom Fields item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Unique identifier of the custom field
value	string	Optional	Value of the custom field

Get Note — response body

Field	Type	Presence	Description and constraints
$	object	Root
note	JSON	Optional	Note details
note (allOf 1)	Model	All variants apply	Expand Get All Notes — response body — notes item

Referenced models: Get All Notes — response body — notes item

Get Task — response body

Field	Type	Presence	Description and constraints
$	object	Root
task	JSON	Optional	Task details
task (allOf 1)	Model	All variants apply	Expand Get all Tasks — response body — tasks item

Referenced models: Get all Tasks — response body — tasks item

Get all Tasks — response body

Field	Type	Presence	Description and constraints
$	object	Root
tasks	array	Optional	List of tasks
tasks[]	Model	Each item	Expand Get all Tasks — response body — tasks item

Referenced models: Get all Tasks — response body — tasks item

Get all Tasks — response body — tasks item

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	User Id to whom the task is assigned
body	string	Optional	Body or description of the task
completed	boolean	Optional	Whether the task is completed
contactId	string	Optional	Contact Id associated with the task
dueDate	string	Optional	Due date of the task (ISO 8601 format)
id	string	Optional	Unique identifier of the task
title	string	Optional	Title of the task

Remove Followers — contacts remove Followers Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
followers	array	Optional	Current followers after the operation
followers[]	string	Each item
followersRemoved	array	Optional	Followers that were removed
followersRemoved[]	string	Each item

Update Contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address1	JSON	Optional
address1 (anyOf 1)	string	Alternative	Street address of the contact
address1 (anyOf 2)	null	Alternative
assignedTo	JSON	Optional
assignedTo (anyOf 1)	string	Alternative	User's Id
assignedTo (anyOf 2)	null	Alternative
city	JSON	Optional
city (anyOf 1)	string	Alternative	City of the contact
city (anyOf 2)	null	Alternative
country	string	Optional	Country code of the contact (ISO 3166-1 alpha-2), Refer country list from documentaion, documentation has list of all countries
customFields	array	Optional	List of custom field values to assign to the contact
customFields[]	JSON	Each item
customFields[] (anyOf 1)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field
customFields[] (anyOf 2)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field
customFields[] (anyOf 3)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field
customFields[] (anyOf 4)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field
customFields[] (anyOf 5)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field
customFields[] (anyOf 6)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field
customFields[] (anyOf 7)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field
customFields[] (anyOf 8)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field
customFields[] (anyOf 9)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field
dateOfBirth	JSON	Optional
dateOfBirth (anyOf 1)	object	Alternative	The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
dateOfBirth (anyOf 2)	null	Alternative
dnd	boolean	Optional	Whether Do Not Disturb is enabled for the contact
dndSettings	JSON	Optional	Per-channel DND settings for the contact
dndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App
email	JSON	Optional
email (anyOf 1)	string	Alternative	Email address of the contact
email (anyOf 2)	null	Alternative
firstName	JSON	Optional
firstName (anyOf 1)	string	Alternative	First name of the contact
firstName (anyOf 2)	null	Alternative
inboundDndSettings	JSON	Optional	Inbound DND settings per channel for the contact
inboundDndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body inbound Dnd Settings all
lastName	JSON	Optional
lastName (anyOf 1)	string	Alternative	Last name of the contact
lastName (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	Full name of the contact
name (anyOf 2)	null	Alternative
phone	JSON	Optional
phone (anyOf 1)	string	Alternative	Phone number of the contact
phone (anyOf 2)	null	Alternative
postalCode	string	Optional	Postal code of the contact
source	JSON	Optional
source (anyOf 1)	string	Alternative	Source from which the contact was updated
source (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State of the contact
state (anyOf 2)	null	Alternative
tags	array	Optional	This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
tags[]	string	Each item
timezone	JSON	Optional
timezone (anyOf 1)	string	Alternative	Timezone of the contact
timezone (anyOf 2)	null	Alternative
website	JSON	Optional
website (anyOf 1)	string	Alternative	Website URL of the contact
website (anyOf 2)	null	Alternative

Referenced models: Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field, Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App, Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field, Create Contact — request body — body inbound Dnd Settings all, Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field

Update Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
contact	JSON	Optional	Contact details
contact (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website
succeeded	boolean	Optional	Whether the update operation succeeded

Referenced models: Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website

Update Contacts Tags — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contacts	array	Required within parent	list of contact ids to be processed
contacts[]	string	Each item
locationId	string	Required within parent	location id from where the bulk request is executed
removeAllTags	boolean	Optional	Option to implement remove all tags. if true, all tags will be removed from the contacts. Can only be used with remove type.
tags	array	Required within parent	list of tags to be added or removed
tags[]	string	Each item

Update Contacts Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root
errorCount	JSON	Required within parent
errorCount (anyOf 1)	number	Alternative	Number of errors encountered during the operation
errorCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
responses	array	Required within parent	Responses for each contact processed
responses[]	string	Each item
succeded	boolean	Required within parent	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Required within parent	Indicates if the operation was successful

Update Note — contacts update Note — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Optional	Body content of the note
color	string	Optional	Hex color code for the note
pinned	boolean	Optional	Whether the note is pinned
title	string	Optional	Title of the note
userId	string	Optional	User Id of the note author

Update Task Completed — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
completed	boolean	Required within parent	Whether the task is completed

Update Task — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	User Id to whom the task is assigned
body	string	Optional	Body or description of the task
completed	boolean	Optional	Whether the task is completed
dueDate	string	Optional	Due date of the task (ISO 8601 format)
title	string	Optional	Title of the task

Upsert Contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address1	JSON	Optional
address1 (anyOf 1)	string	Alternative	Street address of the contact
address1 (anyOf 2)	null	Alternative
assignedTo	string	Optional	User's Id
city	JSON	Optional
city (anyOf 1)	string	Alternative	City of the contact
city (anyOf 2)	null	Alternative
companyName	JSON	Optional
companyName (anyOf 1)	string	Alternative	Company name of the contact
companyName (anyOf 2)	null	Alternative
country	string	Optional	Country code of the contact (ISO 3166-1 alpha-2)
createNewIfDuplicateAllowed	boolean	Optional	Controls whether to create a new contact or update an existing duplicate. **Scenario 1:** If this value is `true` and the location allows duplicate contacts, a new contact will be created immediately without checking for duplicates. **Scenario 2:** If this value is `true` but the location does not allow duplicate contacts, this field is ignored and the normal upsert behavior applies: the API will search for an existing duplicate contact, update it if found, or create a new contact if not found. **Scenario 3:** If this value is `false` or not provided, the normal upsert behavior applies regardless of the location's duplicate contact setting. Default: false
customFields	array	Optional	List of custom field values to assign to the contact
customFields[]	JSON	Each item
customFields[] (anyOf 1)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field
customFields[] (anyOf 2)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field
customFields[] (anyOf 3)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field
customFields[] (anyOf 4)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field
customFields[] (anyOf 5)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field
customFields[] (anyOf 6)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field
customFields[] (anyOf 7)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field
customFields[] (anyOf 8)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field
customFields[] (anyOf 9)	Model	Alternative	Expand Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field
dateOfBirth	JSON	Optional
dateOfBirth (anyOf 1)	object	Alternative	The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
dateOfBirth (anyOf 2)	null	Alternative
dnd	boolean	Optional	Whether Do Not Disturb is enabled for the contact
dndSettings	JSON	Optional	Per-channel DND settings for the contact
dndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App
email	JSON	Optional
email (anyOf 1)	string	Alternative	Email address of the contact
email (anyOf 2)	null	Alternative
firstName	JSON	Optional
firstName (anyOf 1)	string	Alternative	First name of the contact
firstName (anyOf 2)	null	Alternative
gender	string	Optional	Gender of the contact
inboundDndSettings	JSON	Optional	Inbound DND settings per channel for the contact
inboundDndSettings (allOf 1)	Model	All variants apply	Expand Create Contact — request body — body inbound Dnd Settings all
lastName	JSON	Optional
lastName (anyOf 1)	string	Alternative	Last name of the contact
lastName (anyOf 2)	null	Alternative
locationId	string	Required within parent	Location Id the contact should be created under
name	JSON	Optional
name (anyOf 1)	string	Alternative	Full name of the contact
name (anyOf 2)	null	Alternative
phone	JSON	Optional
phone (anyOf 1)	string	Alternative	Phone number of the contact
phone (anyOf 2)	null	Alternative
postalCode	string	Optional	Postal code of the contact
source	string	Optional	Source from which the contact was created
state	JSON	Optional
state (anyOf 1)	string	Alternative	State of the contact
state (anyOf 2)	null	Alternative
tags	array	Optional	This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
tags[]	string	Each item
timezone	JSON	Optional
timezone (anyOf 1)	string	Alternative	Timezone of the contact
timezone (anyOf 2)	null	Alternative
website	JSON	Optional
website (anyOf 1)	string	Alternative	Website URL of the contact
website (anyOf 2)	null	Alternative

Referenced models: Create Contact — request body — body custom Fields item field Value, field value, id, key — Checkbox Field, Create Contact — request body — body dnd Settings call, email, fb, gmb, sms, whats App, Create Contact — request body — body custom Fields item field Value, field value, id, key — File Field, Create Contact — request body — body inbound Dnd Settings all, Create Contact — request body — body custom Fields item field Value, field value, id, key — Large Text Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Monetory Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Multi Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Numeric Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Radio Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Single Select Field, Create Contact — request body — body custom Fields item field Value, field value, id, key — Text Field

Upsert Contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
contact	JSON	Optional	Contact details
contact (allOf 1)	Model	All variants apply	Expand Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website
new	boolean	Optional	Whether a new contact was created (true) or an existing one was updated (false)
traceId	string	Optional	Unique trace identifier for this operation

Referenced models: Get Contact — response body — contact address1, assigned To, attachments, attribution Source, business Id, city, company Name, country, custom Fields, date Added, date Of Birth, date Updated, dnd, dnd Settings, email, email Lower Case, first Name, first Name Lower Case, full Name Lower Case, id, keyword, last Activity, last Attribution Source, last Name, last Name Lower Case, location Id, name, phone, postal Code, source, ssn, state, tags, timezone, type, visitor Id, website