HighLevel: Locations schemas

← Locations operations · All schemas

Create Custom Field — locations create Custom Field — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormat	array	Optional
acceptedFormat[]	string	Each item
dataType	string	Required within parent
isMultipleFile	boolean	Optional
maxNumberOfFiles	number	Optional
model	string	Optional	Model of the custom field you want to create One of: contact, opportunity
name	string	Required within parent
placeholder	string	Optional
position	number	Optional	Default: 0
textBoxListOptions	array	Optional
textBoxListOptions[]	JSON	Each item
textBoxListOptions[] (anyOf 1)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value
textBoxListOptions[] (anyOf 2)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value

Referenced models: Update Custom Field — request body — body text Box List Options item label, prefill Value

Create Custom Value — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent
value	string	Required within parent

Create Recurring Task — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactIds	array	Optional	Contact Id
contactIds[]	string	Each item
description	string	Optional	Description of the task
ignoreTaskCreation	boolean	Optional	Create initial task or not
owners	array	Optional	Assigned To
owners[]	string	Each item
rruleOptions	JSON	Required within parent	Recurring rules
rruleOptions (allOf 1)	Model	All variants apply	Expand Create Recurring Task — request body — body / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly
title	string	Required within parent	Name of the task

Referenced models: Create Recurring Task — request body — body / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Create Recurring Task — request body — body / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Field	Type	Presence	Description and constraints
$	object	Root
count	number	Optional	Max number of task executions
createTaskIfOverDue	boolean	Optional	Create Task If Over Due
dayOfMonth	number	Optional	1, 2, 3, ..., 27, 31
dayOfWeek	string	Optional	One of: MO, TU, WE, TH, FR, SA, SU
dueAfterSeconds	number	Required within parent	Due after seconds
endDate	string	Optional	End Date
interval	number	Required within parent
intervalType	string	Required within parent	One of: yearly, monthly, weekly, daily, hourly
monthOfYear	number	Optional	1, 2, ....., 11, 12
startDate	string	Required within parent	Start Date

Create Recurring Task — response body

Field	Type	Presence	Description and constraints
$	object	Root
recurringTask	JSON	Required within parent	Recurring Tasks
recurringTask (allOf 1)	Model	All variants apply	Expand Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Referenced models: Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Create Recurring Task — response body — recurring Task assigned To, contact Id, created At, deleted, description, id, location Id, rrule Options, title, total Occurrence, updated At

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Assigned To
contactId	string	Optional	Contact Id
createdAt	string	Required within parent	Created At
deleted	boolean	Required within parent	Deleted
description	string	Required within parent	Description of the task
id	string	Required within parent	Recurring Task Id
locationId	string	Required within parent	Location Id
rruleOptions	JSON	Required within parent	Recurring rules
rruleOptions (allOf 1)	Model	All variants apply	Expand Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly
title	string	Required within parent	Name of the task
totalOccurrence	JSON	Required within parent
totalOccurrence (anyOf 1)	number	Alternative	Total Occurrence
totalOccurrence (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Updated At

Referenced models: Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Create Recurring Task — response body — recurringTask / assignedTo, contactId, createdAt, deleted, description, id, locationId, rruleOptions, title, totalOccurrence, updatedAt / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Max number of task executions
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createTaskIfOverDue	boolean	Optional	Create Task If Over Due
dayOfMonth	JSON	Optional
dayOfMonth (anyOf 1)	number	Alternative	1, 2, 3, ..., 27, 31
dayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfWeek	string	Optional	Known values: MO, TU, WE, TH, FR, SA, SU
dueAfterSeconds	JSON	Required within parent
dueAfterSeconds (anyOf 1)	number	Alternative	Due after seconds
dueAfterSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End Date
interval	JSON	Required within parent
interval (anyOf 1)	number	Alternative
interval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalType	string	Required within parent	Known values: yearly, monthly, weekly, daily, hourly
monthOfYear	JSON	Optional
monthOfYear (anyOf 1)	number	Alternative	1, 2, ....., 11, 12
monthOfYear (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Required within parent	Start Date

Create Sub-Account (Formerly Location) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
companyId	string	Required within parent	Company/Agency Id
country	string	Optional	The 2 letter country-code in which the business is present for which sub-account is created One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
mailgun	JSON	Optional	The mailgun credentials for location
mailgun (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain
name	string	Required within parent	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created with the appropriate country-code
postalCode	string	Optional	The postal code of the business for which sub-account is created
prospectInfo	JSON	Optional
prospectInfo (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
snapshotId	string	Optional	The snapshot ID to be loaded into the location.
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
twilio	JSON	Optional	(DEPRECATED) The twilio credentials for location
twilio (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain, Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social, Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name, Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid

Create Tag — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Tag name

Create Tag — response body

Field	Type	Presence	Description and constraints
$	object	Root
tag	Model	Optional	Expand Create Tag — response body — tag

Referenced models: Create Tag — response body — tag

Create Tag — response body — tag

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional
locationId	string	Optional
name	string	Optional

Delete Recurring Task — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Recurring Task Id
success	boolean	Required within parent	Success

Delete tag — response body

Field	Type	Presence	Description and constraints
$	object	Root
succeded	boolean	Optional

GET all or email sms templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
templates	array	Optional
templates[]	JSON	Each item
templates[] (anyOf 1)	Model	Alternative	Expand GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments
templates[] (anyOf 2)	Model	Alternative	Expand GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type
totalCount	JSON	Optional
totalCount (anyOf 1)	number	Alternative
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments

GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Optional
id	string	Optional
locationId	string	Optional
name	string	Optional
template	Model	Optional	Expand GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type template
type	string	Optional

Referenced models: GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type template

GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type template

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Optional
attachments[]	array	Each item
html	string	Optional
subject	string	Optional

GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments

Field	Type	Presence	Description and constraints
$	object	Root
dateAdded	string	Optional
id	string	Optional
locationId	string	Optional
name	string	Optional
template	Model	Optional	Expand GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments template
type	string	Optional
urlAttachments	array	Optional
urlAttachments[]	string	Each item

Referenced models: GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments template

GET all or email sms templates — response body — templates item date Added, id, location Id, name, template, type, url Attachments template

Field	Type	Presence	Description and constraints
$	object	Root
attachments	array	Optional
attachments[]	array	Each item
body	string	Optional

Get Conversation Channel — response body

Field	Type	Presence	Description and constraints
$	object	Root
conversationChannel	Model	Required within parent	Expand Get Conversation Channel — response body — conversation Channel

Referenced models: Get Conversation Channel — response body — conversation Channel

Get Conversation Channel — response body — conversation Channel

Field	Type	Presence	Description and constraints
$	object	Root
Email	array	Optional	List of Email providers configured for this location
Email[]	Model	Each item	Expand Get Conversation Channel — response body — conversation Channel SMS item
SMS	array	Optional	List of SMS providers configured for this location
SMS[]	Model	Each item	Expand Get Conversation Channel — response body — conversation Channel SMS item

Referenced models: Get Conversation Channel — response body — conversation Channel SMS item

Get Conversation Channel — response body — conversation Channel SMS item

Field	Type	Presence	Description and constraints
$	object	Root
conversationProvider	Model	Required within parent	Expand Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Referenced models: Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Get Conversation Channel — response body — conversation Channel SMS item conversation Provider

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Provider ID
default	boolean	Required within parent	Whether this is the default provider
name	string	Required within parent	Provider name
type	string	Required within parent	Provider type Known values: SMS, Email

Get Custom Field — response body

Field	Type	Presence	Description and constraints
$	object	Root
customField	Model	Optional	Expand Get Custom Field — response body — custom Field

Referenced models: Get Custom Field — response body — custom Field

Get Custom Field — response body — custom Field

Field	Type	Presence	Description and constraints
$	object	Root
dataType	string	Optional
fieldKey	string	Optional
id	string	Optional
isAllowedCustomOption	boolean	Optional
isMultiFileAllowed	boolean	Optional
locationId	string	Optional
maxFileLimit	JSON	Optional
maxFileLimit (anyOf 1)	number	Alternative
maxFileLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
model	string	Optional	Model of the custom field Known values: contact, opportunity
name	string	Optional
picklistImageOptions	array	Optional
picklistImageOptions[]	string	Each item
picklistOptions	array	Optional
picklistOptions[]	string	Each item
placeholder	string	Optional
position	JSON	Optional
position (anyOf 1)	number	Alternative
position (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Custom Fields — response body

Field	Type	Presence	Description and constraints
$	object	Root
customFields	array	Optional
customFields[]	Model	Each item	Expand Get Custom Field — response body — custom Field

Referenced models: Get Custom Field — response body — custom Field

Get Custom Value — response body

Field	Type	Presence	Description and constraints
$	object	Root
customValue	Model	Optional	Expand Get Custom Value — response body — custom Value

Referenced models: Get Custom Value — response body — custom Value

Get Custom Value — response body — custom Value

Field	Type	Presence	Description and constraints
$	object	Root
fieldKey	string	Optional
id	string	Optional
locationId	string	Optional
name	string	Optional
value	string	Optional

Get Custom Values — response body

Field	Type	Presence	Description and constraints
$	object	Root
customValues	array	Optional
customValues[]	Model	Each item	Expand Get Custom Value — response body — custom Value

Referenced models: Get Custom Value — response body — custom Value

Get Permissions — response body

Field	Type	Presence	Description and constraints
$	object	Root
permissions	array	Required within parent	Enabled permission names for the sub-account
permissions[]	string	Each item	Known values: 2-way-text-messaging, gmb-messaging, web-chat, reputation-management, facebook-messenger, gmb-call-tracking, missed-call-text-back, text-to-pay, calendar, crm, opportunities, email-marketing, form-builder, survey-builder, trigger-links, html-builder, sms-email-templates, funnels, websites, workflow, membership, all-reports, triggers, campaigns, launchpad

Get Sub-Account (Formerly Location) — response body

Field	Type	Presence	Description and constraints
$	object	Root
location	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location

Referenced models: Get Sub-Account (Formerly Location) — response body — location

Get Sub-Account (Formerly Location) — response body — location

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
business	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location business
city	string	Optional
companyId	string	Optional
country	string	Optional
domain	string	Optional
email	string	Optional
firstName	string	Optional
id	string	Optional
lastName	string	Optional
logoUrl	string	Optional
name	string	Optional
phone	string	Optional
postalCode	string	Optional
reseller	object	Optional
settings	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	Model	Optional	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional
timezone	string	Optional
website	string	Optional

Referenced models: Get Sub-Account (Formerly Location) — response body — location business, Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social

Get Sub-Account (Formerly Location) — response body — location business

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional
city	string	Optional
country	string	Optional
logoUrl	string	Optional
name	string	Optional
postalCode	string	Optional
state	string	Optional
timezone	string	Optional
website	string	Optional

Get Sub-Account (Formerly Location) — response body — location settings

Field	Type	Presence	Description and constraints
$	object	Root
allowDuplicateContact	boolean	Optional
allowDuplicateOpportunity	boolean	Optional
allowFacebookNameMerge	boolean	Optional
disableContactTimezone	boolean	Optional

Get Sub-Account (Formerly Location) — response body — location social

Field	Type	Presence	Description and constraints
$	object	Root
blogRss	string	Optional	Instagram URL
facebookUrl	string	Optional	Facebook URL
foursquare	string	Optional	Foursquare URL
googlePlacesId	string	Optional	Google Business Places ID
googlePlus	string	Optional	Googleplus URL
instagram	string	Optional	Instagram URL
linkedIn	string	Optional	LinkedIn URL
pinterest	string	Optional	Instagram URL
twitter	string	Optional	Twitter URL
yelp	string	Optional	Yelp URL
youtube	string	Optional	Instagram URL

Get Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root
tags	array	Optional
tags[]	Model	Each item	Expand Create Tag — response body — tag

Referenced models: Create Tag — response body — tag

Put Sub-Account (Formerly Location) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
companyId	string	Required within parent	Company/Agency Id
country	string	Optional	The country in which the business is present for which sub-account is created One of: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
mailgun	JSON	Optional	The mailgun credentials for location
mailgun (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
prospectInfo	JSON	Optional
prospectInfo (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
snapshot	JSON	Optional	The snapshot to be updated in the location.
snapshot (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body snapshot id, override
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
twilio	JSON	Optional	(DEPRECATED) The twilio credentials for location
twilio (allOf 1)	Model	All variants apply	Expand Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain, Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social, Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name, Put Sub-Account (Formerly Location) — request body — body snapshot id, override, Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid

Put Sub-Account (Formerly Location) — request body — body mailgun api Key, domain

Field	Type	Presence	Description and constraints
$	object	Root
apiKey	string	Required within parent	API key provided by Mailgun
domain	string	Required within parent	Domain connected with Mailgun

Put Sub-Account (Formerly Location) — request body — body prospect Info email, first Name, last Name

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	Email of the prospect
firstName	string	Required within parent	First name of the prospect
lastName	string	Required within parent	Last name of the prospect

Put Sub-Account (Formerly Location) — request body — body snapshot id, override

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Snaptshot ID
override	boolean	Optional	If you want override all conflicted assets then pass true. Default value is false. Default: false

Put Sub-Account (Formerly Location) — request body — body twilio auth Token, sid

Field	Type	Presence	Description and constraints
$	object	Root
authToken	string	Required within parent	Auth token provided by Twilio
sid	string	Required within parent	SID provided by Twilio

Put Sub-Account (Formerly Location) — response body

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
companyId	string	Optional	Company/Agency Id
country	string	Optional	The country in which the business is present for which sub-account is created Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
domain	string	Optional
email	string	Optional	The email for the sub-account/location
id	string	Optional	Location Id
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social

Search — response body

Field	Type	Presence	Description and constraints
$	object	Root
locations	array	Optional
locations[]	Model	Each item	Expand Search — response body — locations item

Referenced models: Search — response body — locations item

Search — response body — locations item

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	The address of the business for which sub-account is created
city	string	Optional	The city where the business is located for which sub-account is created
country	string	Optional	The country in which the business is present for which sub-account is created
email	string	Optional	The email for the sub-account/location
id	string	Optional	Location Id
name	string	Optional	The name for the sub-account/location
phone	string	Optional	The phone number of the business for which sub-account is created
postalCode	string	Optional	The postal code of the business for which sub-account is created
settings	JSON	Optional	The default settings for location
settings (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location settings
social	JSON	Optional	The social media links for location
social (allOf 1)	Model	All variants apply	Expand Get Sub-Account (Formerly Location) — response body — location social
state	string	Optional	The state in which the business operates for which sub-account is created
timezone	string	Optional	The timezone of the business for which sub-account is created
website	string	Optional	The website of the business for which sub-account is created

Referenced models: Get Sub-Account (Formerly Location) — response body — location settings, Get Sub-Account (Formerly Location) — response body — location social

Task Search Filter — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	array	Optional	Assigned User Ids
assignedTo[]	string	Each item
businessId	string	Optional	Bussiness Id
completed	boolean	Optional	Task Completed Or Pending
contactId	array	Optional	Contact Ids
contactId[]	string	Each item
limit	number	Optional	Limit To Api Default: 25
query	string	Optional	Search Value
skip	number	Optional	Number Of Tasks To Skip Default: 0

Task Search Filter — response body

Field	Type	Presence	Description and constraints
$	object	Root
tasks	array	Optional
tasks[]	array	Each item

Update Custom Field — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormat	array	Optional
acceptedFormat[]	string	Each item
isMultipleFile	boolean	Optional
maxNumberOfFiles	number	Optional
model	string	Optional	Model of the custom field you want to update One of: contact, opportunity
name	string	Required within parent
placeholder	string	Optional
position	number	Optional	Default: 0
textBoxListOptions	array	Optional
textBoxListOptions[]	JSON	Each item
textBoxListOptions[] (anyOf 1)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value
textBoxListOptions[] (anyOf 2)	Model	Alternative	Expand Update Custom Field — request body — body text Box List Options item label, prefill Value

Referenced models: Update Custom Field — request body — body text Box List Options item label, prefill Value

Update Custom Field — request body — body text Box List Options item label, prefill Value

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Optional
prefillValue	string	Optional

Update Permissions — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
permissions	array	Required within parent	Permission plan values to apply for the sub-account
permissions[]	string	Each item	One of: 2-way-text-messaging, gmb-messaging, web-chat, reputation-management, facebook-messenger, gmb-call-tracking, missed-call-text-back, text-to-pay, calendar, crm, opportunities, email-marketing, form-builder, survey-builder, trigger-links, html-builder, sms-email-templates, funnels, websites, workflow, membership, all-reports, triggers, campaigns, launchpad

Update Recurring Task — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactIds	array	Optional	Contact Id
contactIds[]	string	Each item
description	string	Optional	Description of the task
ignoreTaskCreation	boolean	Optional	Create initial task or not
owners	array	Optional	Assigned To
owners[]	string	Each item
rruleOptions	JSON	Optional	Recurring rules
rruleOptions (allOf 1)	Model	All variants apply	Expand Create Recurring Task — request body — body / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly
title	string	Optional	Name of the task

Referenced models: Create Recurring Task — request body — body / rruleOptions / dayOfWeek: MO, TU, WE, TH, FR, SA, SU, interval Type: yearly, monthly, weekly, daily, hourly

Uploads File to custom Fields — response body

Field	Type	Presence	Description and constraints
$	object	Root
meta	array	Optional	Meta data of uploaded files
meta[]	string	Each item
uploadedFiles	object	Optional	Uploaded files