HighLevel: Ad publishing schemas

← Ad publishing operations · All schemas

Add custom audience member — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	Contact identifier
fbAdAccountId	string	Optional	Facebook ad account ID
locationId	string	Required within parent	Location identifier

Batch update audience members — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
csvPath	string	Optional	CSV file path
dynamicAudience	string	Optional	Dynamic audience flag
locationId	string	Required within parent	Location identifier
operationType	string	Required within parent	Batch operation type
smartlistIds	array	Optional	Smartlist IDs array
smartlistIds[]	string	Each item

Create Facebook integration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adAccountId	string	Optional	Ad account identifier
locationId	string	Required within parent	Location identifier
pageId	string	Required within parent	Facebook page ID

Create Google integration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adAccountId	string	Required within parent	Ad account identifier
locationId	string	Required within parent	Location identifier
mccId	string	Required within parent	MCC identifier

Create Linked In integration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adAccountId	string	Required within parent	Ad account identifier
adAccountName	string	Required within parent	Ad account name
currencyCode	string	Required within parent	Currency code
locationId	string	Required within parent	Location identifier
organizationId	string	Required within parent	Organization identifier

Create conversation form — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Conversation form name
questions	array	Required within parent	Quick-reply questions shown in the welcome message of the conversation form
questions[]	Model	Each item	Expand Create conversation form — request body — body questions item
text	string	Required within parent	Welcome message text

Referenced models: Create conversation form — request body — body questions item

Create conversation form — request body — body questions item

Field	Type	Presence	Description and constraints
$	object	Root
question	string	Required within parent	Question title text
response	string	Optional	Auto-response message

Create lead form — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
content	JSON	Required within parent	Form content
content (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions
creationLocale	JSON	Required within parent	Creation locale
creationLocale (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body creation Locale country, language
hiddenFields	array	Optional	Hidden fields
hiddenFields[]	Model	Each item	Expand Create lead form — request body — body hidden Fields item
name	string	Required within parent	Form name
owner	JSON	Required within parent	Form owner
owner (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body owner sponsored Account
state	string	Required within parent	Form state One of: PUBLISHED

Referenced models: Create lead form — request body — body creation Locale country, language, Create lead form — request body — body hidden Fields item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions, Create lead form — request body — body owner sponsored Account

Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE

Field	Type	Presence	Description and constraints
$	object	Root
callToActionLabel	string	Required within parent	Call to action label One of: VISIT_COMPANY_WEBSITE, DOWNLOAD_NOW, TRY_NOW, VIEW_NOW, LEARN_MORE
callToActionTarget	JSON	Required within parent	Call to action target
callToActionTarget (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE call To Action Target landing Page Url

Referenced models: Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE call To Action Target landing Page Url

Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE call To Action Target landing Page Url

Field	Type	Presence	Description and constraints
$	object	Root
landingPageUrl	string	Required within parent	Landing page URL

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional	Form description
description (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
headline	JSON	Required within parent	Form headline
headline (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
legalInfo	JSON	Required within parent	Legal information
legalInfo (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url
postSubmissionInfo	JSON	Required within parent	Post-submission info
postSubmissionInfo (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message
questions	array	Required within parent	Form questions
questions[]	Model	Each item	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Field	Type	Presence	Description and constraints
$	object	Root
localized	object	Required within parent	Locale-keyed string map

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url

Field	Type	Presence	Description and constraints
$	object	Root
consents	array	Required within parent	Consent entries
consents[]	Model	Each item	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url consents item
legalDisclaimer	JSON	Optional	Legal disclaimer text
legalDisclaimer (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
privacyPolicyUrl	string	Required within parent	Privacy policy URL

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url consents item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url consents item

Field	Type	Presence	Description and constraints
$	object	Root
checkRequired	boolean	Required within parent	Whether consent checkbox is required
consent	JSON	Required within parent	Consent text
consent (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
id	number	Required within parent	Consent identifier

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message

Field	Type	Presence	Description and constraints
$	object	Root
callToAction	JSON	Required within parent	Post-submission call to action
callToAction (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE
message	JSON	Required within parent	Thank-you message
message (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Question field name
predefinedField	string	Optional	Predefined field identifier
question	JSON	Required within parent	Question text
question (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
questionDetails	JSON	Required within parent	Question type details
questionDetails (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details

Field	Type	Presence	Description and constraints
$	object	Root
multipleChoiceQuestionDetails	JSON	Optional	Multiple choice question details
multipleChoiceQuestionDetails (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options
textQuestionDetails	object	Optional	Text question details (empty object for text questions)

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options

Field	Type	Presence	Description and constraints
$	object	Root
options	array	Required within parent	Choice options
options[]	Model	Each item	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options options item

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options options item

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details multiple Choice Question Details options options item

Field	Type	Presence	Description and constraints
$	object	Root
id	number	Required within parent	Option ID
text	JSON	Required within parent	Option text
text (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Create lead form — request body — body creation Locale country, language

Field	Type	Presence	Description and constraints
$	object	Root
country	string	Required within parent	Country code
language	string	Required within parent	Language code

Create lead form — request body — body hidden Fields item

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

Create lead form — request body — body owner sponsored Account

Field	Type	Presence	Description and constraints
$	object	Root
sponsoredAccount	string	Required within parent	Sponsored account URN

Create offline user list job — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
csvPath	string	Optional	CSV file path
isDynamic	boolean	Optional	Dynamic list flag
locationId	string	Required within parent	Location identifier
smartListIds	array	Optional	Smart list IDs
smartListIds[]	string	Each item
userListId	string	Optional	User list identifier

Create page lead form — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
customDisclaimer	JSON	Optional	Custom disclaimer config
customDisclaimer (allOf 1)	Model	All variants apply	Expand Create page lead form — request body — body custom Disclaimer body, checkboxes, title
draftFormId	string	Optional	Draft form ID
greetingCard	JSON	Optional	Greeting card config
greetingCard (allOf 1)	Model	All variants apply	Expand Create page lead form — request body — body greeting Card content, style, title
isDraft	boolean	Optional	If the form is a draft, set to true
locale	string	Optional	Locale
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Lead form name
privacyPolicyLink	string	Required within parent	Privacy policy URL. Required when `isDraft` is false or omitted; optional for drafts.
privacyPolicyText	string	Optional	Privacy policy text
questionPageHeadline	string	Optional	Question page headline
questions	array	Required within parent	List of questions displayed on the lead form. Required (non-empty) when `isDraft` is false or omitted; optional for drafts.
questions[]	Model	Each item	Expand Create page lead form — request body — body questions item
thankYouPage	JSON	Required within parent	Thank you page config. Required when `isDraft` is false or omitted; optional for drafts.
thankYouPage (allOf 1)	Model	All variants apply	Expand Create page lead form — request body — body thank You Page body, business Phone, button Link, button Text, button Type, country Code, title
type	string	Required within parent	Lead form type One of: MORE_VOLUME, HIGHER_INTENT

Referenced models: Create page lead form — request body — body custom Disclaimer body, checkboxes, title, Create page lead form — request body — body questions item, Create page lead form — request body — body greeting Card content, style, title, Create page lead form — request body — body thank You Page body, business Phone, button Link, button Text, button Type, country Code, title

Create page lead form — request body — body custom Disclaimer body, checkboxes, title

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Required within parent	Disclaimer body text
checkboxes	array	Optional	Consent checkboxes the user must agree to before submitting the form
checkboxes[]	Model	Each item	Expand Create page lead form — request body — body custom Disclaimer body, checkboxes, title checkboxes item
title	string	Required within parent	Disclaimer title

Referenced models: Create page lead form — request body — body custom Disclaimer body, checkboxes, title checkboxes item

Create page lead form — request body — body custom Disclaimer body, checkboxes, title checkboxes item

Field	Type	Presence	Description and constraints
$	object	Root
isRequired	boolean	Required within parent	Checkbox required flag
key	string	Required within parent	Checkbox unique key
text	string	Required within parent	Checkbox text label

Create page lead form — request body — body greeting Card content, style, title

Field	Type	Presence	Description and constraints
$	object	Root
content	array	Required within parent	Greeting card content
content[]	string	Each item
style	string	Required within parent	Greeting card style
title	string	Required within parent	Greeting card title

Create page lead form — request body — body questions item

Field	Type	Presence	Description and constraints
$	object	Root
key	string	Required within parent	Question key
label	string	Optional	Question label text shown to the user
options	array	Optional	Answer options for multiple-choice questions (only applies to CUSTOM type)
options[]	Model	Each item	Expand Create page lead form — request body — body questions item options item
type	string	Required within parent	Question input type — use a prefilled type for standard fields or CUSTOM / SHORT_ANSWER for freeform questions One of: CUSTOM, CITY, COMPANY_NAME, COUNTRY, DATE_OF_BIRTH, EMAIL, FIRST_NAME, FULL_NAME, GENDER, JOB_TITLE, LAST_NAME, MARITIAL_STATUS, MILITARY_STATUS, PHONE, POST_CODE, RELATIONSHIP_STATUS, STATE, STREET_ADDRESS, WORK_EMAIL, WORK_PHONE_NUMBER, ZIP, SHORT_ANSWER

Referenced models: Create page lead form — request body — body questions item options item

Create page lead form — request body — body questions item options item

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

Create page lead form — request body — body thank You Page body, business Phone, button Link, button Text, button Type, country Code, title

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Required within parent	Thank you page body
businessPhone	string	Optional	Business phone number
buttonLink	string	Optional	Button destination link
buttonText	string	Required within parent	Button text label
buttonType	string	Required within parent	Button action type
countryCode	string	Optional	Phone country code
title	string	Required within parent	Thank you page title

Get campaign publishing progress — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignId	string	Required within parent	Campaign identifier
hasFailed	boolean	Required within parent	Whether publishing failed (Redis failed status or campaign FAILED)
isComplete	boolean	Required within parent	Whether publishing is finished (Redis complete/failed, processed >= total, or status is no longer PUBLISHING)
processed	JSON	Required within parent
processed (anyOf 1)	number	Alternative	Number of publish steps completed so far
processed (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
publishingStatus	string	Required within parent	Current campaign publishing status in ad-publishing Known values: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total publish steps tracked in Redis (campaign + ad sets + ads)
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get keyword ideas — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
keywords	array	Optional	Seed keywords
keywords[]	string	Each item
languageCode	string	Optional	Language code
locations	array	Optional	Target locations
locations[]	string	Each item
url	string	Required within parent	Target URL

Pause ad — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location identifier

Set default page — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
pageId	string	Required within parent	Facebook page identifier

Update ad status — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
operationType	string	Required within parent	Update operation One of: PAUSED, ARCHIVED, RESUME
type	string	Required within parent	Ad object type One of: adGroup, adCampaign, ad

Update custom audience — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Audience description
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Audience name

Upsert Google campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adGroups	array	Optional	Campaign ad groups
adGroups[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item
adSchedule	array	Optional	Ad schedule rules
adSchedule[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Schedule item
advancedOptions	object	Optional	Advanced options
advertisingChannelSubType	string	Optional	Channel sub type One of: DEMAND_GEN
advertisingChannelType	string	Required within parent	Advertising channel One of: SEARCH, DISCOVERY, DISPLAY, HOTEL, LOCAL, MULTI_CHANNEL, PERFORMANCE_MAX, DEMAND_GEN
assets	JSON	Optional	Campaign assets
assets (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks
audience	JSON	Optional	Campaign audience targeting
audience (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests
biddingStrategy	JSON	Optional	Bidding strategy config
biddingStrategy (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body bidding Strategy type, value
budget	JSON	Optional	Campaign budget
budget (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body / budget / budgetType: DAILY, LIFETIME
campaignGoal	JSON	Optional	Campaign goal config
campaignGoal (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body / campaignGoal / type: CONVERSIONS, CLICK, YOUTUBE ENGAGEMENT
goalType	string	Optional	Goal type One of: WEBSITE_TRAFFIC, LEAD
googleAdAccountId	string	Optional	Google Ad account identifier
googleCampaignId	string	Optional	Google Ads campaign resource ID
id	string	Optional	Campaign identifier
isEuPoliticalAds	boolean	Optional	EU political ads flag
locationId	string	Required within parent	Location identifier
maximumCpc	number	Optional	Maximum CPC bid in micros
name	string	Required within parent	Campaign name
networkSettings	JSON	Optional	Network settings
networkSettings (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body network Settings target Content Network, target Search Network
publishingStatus	string	Optional	Publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
source	string	Optional	Traffic source
unpublishedChanges	boolean	Optional	Whether the campaign has unpublished changes

Referenced models: Upsert Google campaign — request body — body ad Groups item, Upsert Google campaign — request body — body ad Schedule item, Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks, Upsert Google campaign — request body — body bidding Strategy type, value, Upsert Google campaign — request body — body / budget / budgetType: DAILY, LIFETIME, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests, Upsert Google campaign — request body — body / campaignGoal / type: CONVERSIONS, CLICK, YOUTUBE ENGAGEMENT, Upsert Google campaign — request body — body network Settings target Content Network, target Search Network

Upsert Google campaign — request body — body / budget / budgetType: DAILY, LIFETIME

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Optional	Budget amount in micros
budgetType	string	Optional	Budget type One of: DAILY, LIFETIME
scheduleEndDate	string	Optional	Schedule end date
scheduleStartDate	string	Optional	Schedule start date

Upsert Google campaign — request body — body / campaignGoal / type: CONVERSIONS, CLICK, YOUTUBE ENGAGEMENT

Field	Type	Presence	Description and constraints
$	object	Root
isCustomConversionGoal	boolean	Optional	Whether this is a custom conversion goal
type	string	Required within parent	Campaign goal type One of: CONVERSIONS, CLICK, YOUTUBE_ENGAGEMENT
value	string	Optional	Goal value (e.g. conversion action resource name)

Upsert Google campaign — request body — body ad Groups item

Field	Type	Presence	Description and constraints
$	object	Root
adCampaignId	string	Optional	Ad campaign identifier
adContent	array	Optional	Ad content items
adContent[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item ad Content item
adGroupError	string	Optional	Ad group-level error from Google
adGroupId	string	Optional	Google ad group identifier
audience	JSON	Optional	Ad group audience targeting
audience (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body ad Groups item audience geo Locations, locales
customChannels	boolean	Optional	Custom channels flag
googleAdGroupId	string	Optional	Google Ads ad group resource ID
googleAudienceId	string	Optional	Google audience resource ID
id	string	Optional	Ad group identifier
keywords	JSON	Optional	Keyword targeting
keywords (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body ad Groups item keywords negatives, positives
name	string	Optional	Ad group name
publishingStatus	string	Optional	Ad group publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
selectedChannels	array	Optional	Selected channel placements
selectedChannels[]	string	Each item	One of: GMAIL, YOUTUBE_IN_STREAM, YOUTUBE_SHORTS, YOUTUBE_IN_FEED, DISCOVER, DISPLAY

Referenced models: Upsert Google campaign — request body — body ad Groups item ad Content item, Upsert Google campaign — request body — body ad Groups item audience geo Locations, locales, Upsert Google campaign — request body — body ad Groups item keywords negatives, positives

Upsert Google campaign — request body — body ad Groups item ad Content item

Field	Type	Presence	Description and constraints
$	object	Root
adCampaignId	string	Optional	Ad campaign identifier
adError	string	Optional	Ad-level error message from Google
adGroupId	string	Optional	Ad group identifier
adId	string	Optional	Internal ad identifier
businessName	string	Optional	Business name
callToActionLabel	string	Optional	Call to action label One of: AUTOMATED, LEARN_MORE, GET_QUOTE, APPLY_NOW, SIGN_UP, CONTACT_US, SUBSCRIBE, DOWNLOAD, BOOK_NOW, SHOP_NOW, BUY_NOW, DONATE_NOW, ORDER_NOW, PLAY_NOW, SEE_MORE
carouselCards	array	Optional	Carousel cards
carouselCards[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item ad Content item carousel Cards item
customChannels	boolean	Optional	Custom channels flag
descriptions	array	Optional	Ad descriptions
descriptions[]	string	Each item
finalUrl	string	Optional	Final URL
googleAdId	string	Optional	Google Ads ad resource ID
headlines	array	Optional	Ad headlines
headlines[]	string	Each item
id	string	Optional	Ad identifier
isDeleted	boolean	Optional	Whether the ad is soft-deleted
longHeadlines	array	Optional	Long headlines
longHeadlines[]	string	Each item
media	array	Optional	Ad media items
media[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item ad Content item media item
mediaType	string	Optional	Media type One of: IMAGE, VIDEO, CAROUSEL
name	string	Optional	Ad name
path1	string	Optional	Display path 1
path2	string	Optional	Display path 2
placements	array	Optional	Channel placements
placements[]	string	Each item	One of: GMAIL, YOUTUBE_IN_STREAM, YOUTUBE_SHORTS, YOUTUBE_IN_FEED, DISCOVER, DISPLAY
publishingStatus	string	Optional	Ad publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
youtubeVideoLinks	array	Optional	YouTube video links
youtubeVideoLinks[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item ad Content item youtube Video Links item

Referenced models: Upsert Google campaign — request body — body ad Groups item ad Content item carousel Cards item, Upsert Google campaign — request body — body ad Groups item ad Content item media item, Upsert Google campaign — request body — body ad Groups item ad Content item youtube Video Links item

Upsert Google campaign — request body — body ad Groups item ad Content item carousel Cards item

Field	Type	Presence	Description and constraints
$	object	Root
callToActionLabel	string	Optional	Call to action label
finalUrl	string	Optional	Card final URL
headline	string	Optional	Card headline
media	array	Optional	Card media items
media[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item ad Content item media item

Referenced models: Upsert Google campaign — request body — body ad Groups item ad Content item media item

Upsert Google campaign — request body — body ad Groups item ad Content item media item

Field	Type	Presence	Description and constraints
$	object	Root
error	string	Optional	Error message if media failed
imageType	string	Optional	Image type classification
isLogo	boolean	Optional	Is logo flag
src	string	Optional	Media source URL
type	string	Optional	Media type One of: IMAGE
url	string	Optional	Public URL of the media

Upsert Google campaign — request body — body ad Groups item ad Content item youtube Video Links item

Field	Type	Presence	Description and constraints
$	object	Root
youtubeVideoId	string	Required within parent	YouTube video ID

Upsert Google campaign — request body — body ad Groups item audience geo Locations, locales

Field	Type	Presence	Description and constraints
$	object	Root
geoLocations	array	Optional	Geo-location targeting
geoLocations[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item
locales	array	Optional	Language/locale targeting
locales[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests locales item

Referenced models: Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests locales item

Upsert Google campaign — request body — body ad Groups item keywords negatives, positives

Field	Type	Presence	Description and constraints
$	object	Root
negatives	array	Optional	Negative keywords
negatives[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item keywords negatives, positives negatives item
positives	array	Optional	Positive keywords
positives[]	Model	Each item	Expand Upsert Google campaign — request body — body ad Groups item keywords negatives, positives negatives item

Referenced models: Upsert Google campaign — request body — body ad Groups item keywords negatives, positives negatives item

Upsert Google campaign — request body — body ad Groups item keywords negatives, positives negatives item

Field	Type	Presence	Description and constraints
$	object	Root
keyword	string	Required within parent	Keyword text
matchType	string	Required within parent	Match type (BROAD, PHRASE, EXACT)

Upsert Google campaign — request body — body ad Schedule item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfWeek	string	Required within parent	Day of week One of: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, UNSPECIFIED, WEDNESDAY, ALL_DAYS, MONDAY_TO_FRIDAY, SATURDAY_AND_SUNDAY
from	string	Required within parent	Start time (HH:MM)
to	string	Required within parent	End time (HH:MM)

Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks

Field	Type	Presence	Description and constraints
$	object	Root
businessLogo	JSON	Optional	Business logo asset
businessLogo (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks images item
calls	array	Optional	Call extension asset resource names
calls[]	string	Each item
images	array	Optional	Image assets
images[]	Model	Each item	Expand Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks images item
leadForm	string	Optional	Lead form asset resource name
sitelinks	array	Optional	Sitelink asset resource names
sitelinks[]	string	Each item

Referenced models: Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks images item

Upsert Google campaign — request body — body assets business Logo, calls, images, lead Form, sitelinks images item

Field	Type	Presence	Description and constraints
$	object	Root
error	string	Optional	Error message if asset upload failed
name	string	Optional	Asset name
resourceName	string	Optional	Google Ads resource name
url	string	Required within parent	Image URL

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests

Field	Type	Presence	Description and constraints
$	object	Root
ageRange	array	Optional	Age range targeting
ageRange[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests gender item
gender	array	Optional	Gender targeting
gender[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests gender item
geoLocations	array	Optional	Geo-location targeting
geoLocations[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item
locales	array	Optional	Language/locale targeting
locales[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests locales item
segments	array	Optional	Audience segment targeting
segments[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests segments item
targetInterests	JSON	Optional	Interest-based targeting
targetInterests (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests target Interests affinity, in Market

Referenced models: Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests gender item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests locales item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests segments item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests target Interests affinity, in Market

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests gender item

Field	Type	Presence	Description and constraints
$	object	Root
enum	string	Required within parent	Demographic enum value
negative	boolean	Required within parent	Whether this is a negative target

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item

Field	Type	Presence	Description and constraints
$	object	Root
addressComponents	array	Optional	Address components from Google Geocoding API
addressComponents[]	Model	Each item	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item address Components item
countryName	string	Optional	Country name
formattedAddress	string	Optional	Full formatted address string
geometry	JSON	Optional	Geometry data from Google Geocoding API
geometry (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport
id	string	Optional	Location identifier (place_id)
key	string	Optional	Geo target constant resource name
name	string	Optional	Location display name
placeId	string	Optional	Google place ID
radius	number	Optional	Radius for proximity targeting
radiusUnit	string	Optional	Radius unit One of: km, mi
resourceName	string	Optional	Google Ads resource name
selectionType	string	Optional	Include or exclude this location One of: include, exclude
type	string	Optional	Location type (city, region, country, address, etc.)

Referenced models: Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item address Components item, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item address Components item

Field	Type	Presence	Description and constraints
$	object	Root
longName	string	Optional	Full name of the address component
shortName	string	Optional	Abbreviated name of the address component
types	array	Optional	Address component types
types[]	string	Each item

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport

Field	Type	Presence	Description and constraints
$	object	Root
location	JSON	Optional	Location coordinates
location (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng
locationType	string	Optional	Location type (e.g. APPROXIMATE)
viewport	JSON	Optional	Viewport bounding box
viewport (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport viewport northeast, southwest

Referenced models: Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng, Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport viewport northeast, southwest

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng

Field	Type	Presence	Description and constraints
$	object	Root
lat	number	Optional	Latitude
lng	number	Optional	Longitude

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport viewport northeast, southwest

Field	Type	Presence	Description and constraints
$	object	Root
northeast	JSON	Optional	Northeast corner of the viewport
northeast (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng
southwest	JSON	Optional	Southwest corner of the viewport
southwest (allOf 1)	Model	All variants apply	Expand Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng

Referenced models: Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests geo Locations item geometry location, location Type, viewport location lat, lng

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests locales item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Language identifier
key	string	Optional	Language key
name	string	Optional	Language display name
resourceName	string	Optional	Language resource name

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests segments item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Segment identifier
type	string	Required within parent	Segment type

Upsert Google campaign — request body — body audience age Range, gender, geo Locations, locales, segments, target Interests target Interests affinity, in Market

Field	Type	Presence	Description and constraints
$	object	Root
affinity	array	Optional	Affinity audience IDs
affinity[]	string	Each item
inMarket	array	Optional	In-market audience IDs
inMarket[]	string	Each item

Upsert Google campaign — request body — body bidding Strategy type, value

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Optional	Bidding strategy type
value	number	Optional	Bid value in micros

Upsert Google campaign — request body — body network Settings target Content Network, target Search Network

Field	Type	Presence	Description and constraints
$	object	Root
targetContentNetwork	boolean	Required within parent	Target Google Display Network
targetSearchNetwork	boolean	Required within parent	Target Google Search Network

Upsert ad campaign group — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adBudgetOptimization	string	Optional	Ad budget optimization mode One of: MAXIMUM_DELIVERY, COST_CAP
adCampaignGroupId	string	Optional	LinkedIn campaign group resource ID
adCampaigns	array	Optional	Child ad campaigns
adCampaigns[]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item
budget	JSON	Optional	Campaign group budget
budget (allOf 1)	Model	All variants apply	Expand Upsert ad campaign group — request body — body / budget / budgetType: DAILY, LIFETIME
id	string	Optional	Internal ID
linkedInAdAccountId	string	Optional	LinkedIn ad account identifier
linkedInError	string	Optional	LinkedIn API error message
locationId	string	Required within parent	Location ID
meta	object	Optional	Additional metadata
name	string	Optional	Campaign group name
objectiveType	string	Optional	Campaign group objective One of: LEAD_GENERATION, WEBSITE_VISIT
publishingStatus	string	Optional	Publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
unpublishedChanges	boolean	Optional	Whether the campaign group has unpublished changes

Referenced models: Upsert ad campaign group — request body — body ad Campaigns item, Upsert ad campaign group — request body — body / budget / budgetType: DAILY, LIFETIME

Upsert ad campaign group — request body — body / budget / budgetType: DAILY, LIFETIME

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Optional	Budget amount (currency minor units)
budgetType	string	Optional	LinkedIn campaign budget type One of: DAILY, LIFETIME
scheduleEndDate	string	Optional	Schedule end date (ISO 8601)
scheduleStartDate	string	Optional	Schedule start date (ISO 8601)

Upsert ad campaign group — request body — body ad Campaigns item

Field	Type	Presence	Description and constraints
$	object	Root
adCampaignGroupId	string	Optional	Parent campaign group identifier
adCampaignId	string	Optional	LinkedIn campaign resource ID
ads	array	Optional	Ads in the campaign
ads[]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item ads item
audience	JSON	Optional	Campaign audience targeting
audience (allOf 1)	Model	All variants apply	Expand Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience
campaignType	string	Optional	LinkedIn campaign type
id	string	Optional	Internal campaign identifier
linkedInError	string	Optional	LinkedIn API error message
locale	JSON	Optional	Campaign locale
locale (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body creation Locale country, language
mediaType	string	Optional	Creative media type for the campaign One of: STANDARD_UPDATE, SINGLE_VIDEO, CAROUSEL
meta	object	Optional	Additional campaign metadata
name	string	Optional	Campaign name
publishingStatus	string	Optional	Publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED
unitCost	JSON	Optional	Bid unit cost
unitCost (allOf 1)	Model	All variants apply	Expand Upsert ad campaign group — request body — body ad Campaigns item unit Cost amount

Referenced models: Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience, Create lead form — request body — body creation Locale country, language, Upsert ad campaign group — request body — body ad Campaigns item ads item, Upsert ad campaign group — request body — body ad Campaigns item unit Cost amount

Upsert ad campaign group — request body — body ad Campaigns item ads item

Field	Type	Presence	Description and constraints
$	object	Root
adCampaignGroupId	string	Optional	Parent campaign group identifier
adCampaignId	string	Optional	Parent ad campaign identifier
adId	string	Optional	LinkedIn ad resource ID
callToActionLabel	string	Optional	Call to action label
contentReferenceString	string	Optional	Content reference URN for boosted posts
description	string	Optional	Ad description
destinationFormId	string	Optional	Destination lead-gen form ID
destinationUrl	string	Optional	Click-through destination URL
headline	string	Optional	Ad headline
id	string	Optional	Ad identifier
introductoryText	string	Optional	Introductory ad copy shown above the creative
linkedInError	string	Optional	LinkedIn API error message
media	array	Optional	Ad creative media
media[]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item ads item media item
meta	object	Optional	Additional ad metadata
name	string	Optional	Ad name
publishingStatus	string	Optional	Ad publishing status One of: DRAFT, SCHEDULED, PUBLISHED, PUBLISHING, FAILED, IN_REVIEW, PAUSED, ARCHIVED, WITH_ISSUES, REJECTED

Referenced models: Upsert ad campaign group — request body — body ad Campaigns item ads item media item

Upsert ad campaign group — request body — body ad Campaigns item ads item media item

Field	Type	Presence	Description and constraints
$	object	Root
destinationUrl	string	Optional	Click-through destination URL
fileSizeBytes	number	Optional	File size in bytes
frames	array	Optional	Video frame URLs
frames[]	string	Each item
headline	string	Optional	Media headline
name	string	Optional	Media name
selectedPoster	number	Optional	Selected poster frame index
src	string	Optional	Media source URL
thumbnailUrl	string	Optional	Thumbnail URL
type	string	Optional	Media type One of: video, image

Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience

Field	Type	Presence	Description and constraints
$	object	Root
geoLocations	array	Optional	Geographic location targets
geoLocations[]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience geo Locations item
targetAudience	JSON	Optional	Target audience attribute selections
targetAudience (allOf 1)	Model	All variants apply	Expand Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include

Referenced models: Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience geo Locations item, Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include

Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience geo Locations item

Field	Type	Presence	Description and constraints
$	object	Root
facetUrn	string	Required within parent	Facet URN
name	string	Required within parent	Location display name
selectionType	string	Required within parent	Selection type One of: include, exclude
urn	string	Required within parent	Location URN

Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include

Field	Type	Presence	Description and constraints
$	object	Root
exclude	array	Optional	Excluded targeting attributes
exclude[]	array	Each item
exclude[][]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include exclude item item
include	array	Optional	Included targeting attributes (groups of ANDed attributes, ORed together)
include[]	array	Each item
include[][]	Model	Each item	Expand Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include exclude item item

Referenced models: Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include exclude item item

Upsert ad campaign group — request body — body ad Campaigns item audience geo Locations, target Audience target Audience exclude, include exclude item item

Field	Type	Presence	Description and constraints
$	object	Root
categoryName	string	Required within parent	Category name
facet	string	Required within parent	Facet identifier
name	string	Required within parent	Display name
urn	string	Required within parent	Targeting attribute URN

Upsert ad campaign group — request body — body ad Campaigns item unit Cost amount

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Bid amount in currency minor units

Upsert ad — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
adsetId	string	Required within parent	Parent ad set ID
campaignId	string	Required within parent	Parent campaign ID
conversationFormId	string	Optional	Conversation form ID
cta	string	Optional	Call to action type
description	string	Optional	Ad description text
destinationFormId	string	Optional	Destination form ID
destinationLink	string	Optional	Destination link URL
headline	string	Optional	Ad headline text
id	string	Optional	Ad identifier
imageUrl	string	Optional	Ad image URL
locationId	string	Required within parent	Location identifier
media	array	Optional	Media items (images or videos) attached to the ad creative
media[]	Model	Each item	Expand Upsert ad — request body — body media item
mediaType	string	Optional	Ad media type One of: SINGLE, CAROUSEL
multiAdvertiserAds	boolean	Optional	Enable multi-advertiser ads
name	string	Optional	Ad name
primaryText	string	Optional	Ad primary text

Referenced models: Upsert ad — request body — body media item

Upsert ad — request body — body media item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Media description
headline	string	Optional	Media headline
link	string	Optional	Media destination link
name	string	Optional	Media file name
selectedPoster	number	Optional	Selected poster index (required when type is video)
src	string	Required within parent	Media source URL
thumbnailUrl	string	Optional	Thumbnail URL (required when type is video)
type	string	Required within parent	Media content type One of: image, video

Upsert adset — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
audience	JSON	Optional	Targeting audience configuration including geo-locations, locales, placements, and custom audiences
audience (allOf 1)	Model	All variants apply	Expand Upsert adset — request body — body / audience / placementType: auto, manual
budget	JSON	Optional	Ad set budget config
budget (allOf 1)	Model	All variants apply	Expand Upsert adset — request body — body / budget / budgetType: DAILY, LIFETIME
campaignId	string	Required within parent	Parent campaign ID
conversionLocation	string	Optional	Conversion location
customEventType	string	Optional	Custom event type
id	string	Optional	Ad set identifier
instagramActorId	string	Optional	Instagram actor ID
locationId	string	Required within parent	Location identifier
messagingPlatforms	array	Optional	Messaging platforms
messagingPlatforms[]	string	Each item	One of: WHATSAPP, MESSENGER, INSTAGRAM_DIRECT
name	string	Optional	Ad set name
pageId	string	Optional	Facebook page ID
pixelId	string	Optional	Conversion pixel ID
whatsappNumber	string	Optional	WhatsApp phone number

Referenced models: Upsert adset — request body — body / budget / budgetType: DAILY, LIFETIME, Upsert adset — request body — body / audience / placementType: auto, manual

Upsert adset — request body — body / audience / placementType: auto, manual

Field	Type	Presence	Description and constraints
$	object	Root
ageMax	number	Optional	Maximum age for targeting
ageMin	number	Optional	Minimum age for targeting
genders	array	Optional	Gender targeting (1 = male, 2 = female)
genders[]	number	Each item
geoLocations	array	Required within parent	Geographic locations to target or exclude
geoLocations[]	Model	Each item	Expand Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item
interests	array	Optional	Interest-based targeting criteria
interests[]	Model	Each item	Expand Upsert adset — request body — body / audience / placementType: auto, manual interests item
locales	array	Optional	Language locales to target
locales[]	Model	Each item	Expand Upsert adset — request body — body / audience / placementType: auto, manual locales item
lookalike	array	Optional	Lookalike audiences to target
lookalike[]	Model	Each item	Expand Upsert adset — request body — body / audience / placementType: auto, manual lookalike item
placementType	string	Optional	Placement strategy — "auto" lets Facebook choose, "manual" uses the placements config One of: auto, manual
placements	JSON	Optional	Ad placement positions per platform (only used when placementType is "manual")
placements (allOf 1)	Model	All variants apply	Expand Upsert adset — request body — body / audience / placementType: auto, manual placements facebook, instagram, messenger
retargeting	array	Optional	Retargeting custom audiences to target
retargeting[]	Model	Each item	Expand Upsert adset — request body — body / audience / placementType: auto, manual lookalike item

Referenced models: Upsert adset — request body — body / audience / placementType: auto, manual lookalike item, Upsert adset — request body — body / audience / placementType: auto, manual interests item, Upsert adset — request body — body / audience / placementType: auto, manual locales item, Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item, Upsert adset — request body — body / audience / placementType: auto, manual placements facebook, instagram, messenger

Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item

Field	Type	Presence	Description and constraints
$	object	Root
geometry	JSON	Optional	Geometry data for address-based targeting
geometry (allOf 1)	Model	All variants apply	Expand Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item geometry location, location Type
key	string	Required within parent	Facebook location key
name	string	Required within parent	Location display name
radius	number	Optional	Targeting radius around the location (for city/address types)
radiusUnit	string	Optional	Unit for the targeting radius One of: km, mi
selectionType	string	Required within parent	Whether the location is included or excluded from targeting One of: include, exclude
type	string	Required within parent	Geographic location type One of: country, city, region, country_group, geo_market, large_geo_area, medium_geo_area, small_geo_area, subcity, neighborhood, zip, address

Referenced models: Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item geometry location, location Type

Upsert adset — request body — body / audience / placementType: auto, manual geo Locations item geometry location, location Type

Field	Type	Presence	Description and constraints
$	object	Root
location	object	Required within parent	Geographic coordinates
locationType	string	Required within parent	Geocoding result type

Upsert adset — request body — body / audience / placementType: auto, manual interests item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Interest ID
name	string	Required within parent	Interest name
type	string	Optional	Interest category type (defaults to "interests" if omitted)

Upsert adset — request body — body / audience / placementType: auto, manual locales item

Field	Type	Presence	Description and constraints
$	object	Root
key	number	Required within parent	Facebook locale key
name	string	Required within parent	Locale display name

Upsert adset — request body — body / audience / placementType: auto, manual lookalike item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Custom audience ID
name	string	Required within parent	Custom audience name

Upsert adset — request body — body / audience / placementType: auto, manual placements facebook, instagram, messenger

Field	Type	Presence	Description and constraints
$	object	Root
facebook	array	Optional	Facebook placement positions
facebook[]	string	Each item
instagram	array	Optional	Instagram placement positions
instagram[]	string	Each item
messenger	array	Optional	Messenger placement positions
messenger[]	string	Each item

Upsert adset — request body — body / budget / budgetType: DAILY, LIFETIME

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Budget amount
budgetType	string	Required within parent	Budget type One of: DAILY, LIFETIME
scheduleEndDate	string	Optional	Schedule end date
scheduleStartDate	string	Optional	Schedule start date

Upsert assets — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location identifier
payload	JSON	Required within parent	Asset payload — shape depends on the type field: CallAssetPayload (CALL), SitelinkAssetPayload (SITELINK), or LeadFormAssetPayload (LEAD_FORM)
payload (oneOf 1)	Model	Alternative	Expand Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name
payload (oneOf 2)	Model	Alternative	Expand Upsert assets — request body — body payload ad Schedule Targets, description1, description2, end Date, final Urls, link Text, resource Name, start Date
payload (oneOf 3)	Model	Alternative	Expand Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW
type	string	Required within parent	Asset type to create or update One of: CALL, SITELINK, LEAD_FORM

Referenced models: Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name, Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW, Upsert assets — request body — body payload ad Schedule Targets, description1, description2, end Date, final Urls, link Text, resource Name, start Date

Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW

Field	Type	Presence	Description and constraints
$	object	Root
backgroundImageAsset	string	Optional	Background image asset resource name
businessName	string	Required within parent	Business name shown on the form
callToActionDescription	string	Optional	Description text for the CTA button
callToActionType	string	Required within parent	Call to action button type One of: LEARN_MORE, GET_QUOTE, APPLY_NOW, SIGN_UP, CONTACT_US, SUBSCRIBE, DOWNLOAD, BOOK_NOW, GET_OFFER, REGISTER, GET_INFO, REQUEST_DEMO, JOIN_NOW, GET_STARTED, VISIT_SITE
customQuestionFields	array	Optional	Custom question fields appended after standard fields
customQuestionFields[]	Model	Each item	Expand Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW custom Question Fields item
description	string	Required within parent	Lead form description
desiredIntent	string	Optional	Desired lead intent level One of: LOW_INTENT, HIGH_INTENT
fields	array	Required within parent	Form fields to collect user input
fields[]	Model	Each item	Expand Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW fields item
finalUrls	string	Optional	Final URL shown after form submission
headline	string	Required within parent	Lead form headline
postSubmitCallToActionType	string	Optional	Post-submit CTA button type One of: VISIT_SITE, DOWNLOAD, LEARN_MORE, SHOP_NOW
postSubmitDescription	string	Optional	Description shown after form submission
postSubmitHeadline	string	Optional	Headline shown after form submission
privacyPolicyUrl	string	Required within parent	Privacy policy URL
resourceName	string	Optional	Google Ads resource name for an existing lead form asset

Referenced models: Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW custom Question Fields item, Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW fields item

Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW custom Question Fields item

Field	Type	Presence	Description and constraints
$	object	Root
customQuestionText	string	Required within parent	Custom question text shown to the user
singleChoiceAnswers	array	Required within parent	Answer choices for the custom question
singleChoiceAnswers[]	string	Each item

Upsert assets — request body — body / payload / desiredIntent: LOW INTENT, HIGH INTENT, post Submit Call To Action Type: VISIT SITE, DOWNLOAD, LEARN MORE, SHOP NOW fields item

Field	Type	Presence	Description and constraints
$	object	Root
inputType	string	Required within parent	Field input type from Google Ads LeadFormFieldUserInputType
singleChoiceAnswers	array	Optional	Single-choice answer options for the field
singleChoiceAnswers[]	string	Each item

Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name

Field	Type	Presence	Description and constraints
$	object	Root
adScheduleTargets	array	Optional	Ad schedule targets restricting when the call asset is shown
adScheduleTargets[]	Model	Each item	Expand Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name ad Schedule Targets item
callConversionAction	string	Optional	Call conversion action resource name
countryCode	string	Required within parent	Two-letter ISO country code
phoneNumber	string	Required within parent	Phone number for call ads
resourceName	string	Optional	Google Ads resource name for an existing call asset

Referenced models: Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name ad Schedule Targets item

Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name ad Schedule Targets item

Field	Type	Presence	Description and constraints
$	object	Root
dayOfWeek	string	Required within parent	Day of the week for this schedule One of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
endHour	number	Required within parent	End hour in 24h format (0-23)
endMinute	string	Required within parent	Minute mark the schedule ends at One of: ZERO, FIFTEEN, THIRTY, FORTY_FIVE
startHour	number	Required within parent	Start hour in 24h format (0-23)
startMinute	string	Required within parent	Minute mark the schedule starts at One of: ZERO, FIFTEEN, THIRTY, FORTY_FIVE

Upsert assets — request body — body payload ad Schedule Targets, description1, description2, end Date, final Urls, link Text, resource Name, start Date

Field	Type	Presence	Description and constraints
$	object	Root
adScheduleTargets	array	Optional	Ad schedule targets restricting when the sitelink is shown
adScheduleTargets[]	Model	Each item	Expand Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name ad Schedule Targets item
description1	string	Optional	First description line
description2	string	Optional	Second description line
endDate	string	Optional	End date for the sitelink (YYYY-MM-DD)
finalUrls	string	Required within parent	Final landing page URL
linkText	string	Required within parent	Sitelink display text
resourceName	string	Optional	Google Ads resource name for an existing sitelink asset
startDate	string	Optional	Start date for the sitelink (YYYY-MM-DD)

Referenced models: Upsert assets — request body — body payload ad Schedule Targets, call Conversion Action, country Code, phone Number, resource Name ad Schedule Targets item

Upsert audience — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
dimensions	JSON	Optional	Audience dimensions
dimensions (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses
exclusionDimension	JSON	Optional	Exclusion dimensions
exclusionDimension (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Audience name
resourceName	string	Optional	Audience resource name

Referenced models: Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses

Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses

Field	Type	Presence	Description and constraints
$	object	Root
ageRanges	array	Optional	Age range filters
ageRanges[]	string	Each item
audienceSegments	JSON	Optional	Audience segment references used for targeting
audienceSegments (allOf 1)	Model	All variants apply	Expand Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists
genders	array	Optional	Gender targets
genders[]	string	Each item
isAgeUnknown	boolean	Optional	Include unknown age
parentalStatuses	array	Optional	Parental status targets
parentalStatuses[]	string	Each item

Referenced models: Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists

Upsert audience — request body — body dimensions age Ranges, audience Segments, genders, is Age Unknown, parental Statuses audience Segments custom Audiences, user Interests, user Lists

Field	Type	Presence	Description and constraints
$	object	Root
customAudiences	array	Optional	Resource names of custom audience segments
customAudiences[]	string	Each item
userInterests	array	Optional	Resource names of user interest segments (in-market or affinity audiences)
userInterests[]	string	Each item
userLists	array	Optional	Resource names of user lists (remarketing lists, customer match lists, etc.)
userLists[]	string	Each item

Upsert campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	Campaign identifier
locationId	string	Required within parent	Location identifier
name	string	Optional	Campaign name
objective	string	Optional	Campaign objective One of: OUTCOME_LEADS, OUTCOME_TRAFFIC, OUTCOME_ENGAGEMENT, OUTCOME_SALES
source	string	Optional	Campaign data source
specialAdCategories	array	Optional	Special ad categories
specialAdCategories[]	string	Each item	One of: EMPLOYMENT, CREDIT, FINANCIAL_PRODUCTS_SERVICES, HOUSING, ISSUES_ELECTIONS_POLITICS, ONLINE_GAMBLING_AND_GAMING, NONE

Upsert conversion pixel — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
conversionPixelId	string	Optional	Conversion pixel ID
igUserId	string	Optional	Instagram user ID
locationId	string	Required within parent	Location identifier
name	string	Optional	Pixel name
type	string	Required within parent	Pixel event type

Upsert conversion — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
attributionModel	string	Required within parent	Attribution model used to credit conversions One of: GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN, GOOGLE_ADS_LAST_CLICK
category	string	Required within parent	Conversion category
clickThroughWindow	number	Required within parent	Click-through conversion window in days
conversionId	string	Optional	Conversion identifier
countingType	string	Required within parent	How conversions are counted per interaction One of: ONE_PER_CLICK, MANY_PER_CLICK
locationId	string	Required within parent	Location identifier
name	string	Required within parent	Conversion name
type	string	Required within parent	Conversion type One of: UPLOAD_CLICKS, UPLOAD_CALLS, WEBPAGE, LEAD_FORM_SUBMIT
valueSettings	JSON	Required within parent	Value settings that control how monetary value is attributed to conversions
valueSettings (allOf 1)	Model	All variants apply	Expand Upsert conversion — request body — body value Settings always Use Default Value, default Currency Code, default Value

Referenced models: Upsert conversion — request body — body value Settings always Use Default Value, default Currency Code, default Value

Upsert conversion — request body — body value Settings always Use Default Value, default Currency Code, default Value

Field	Type	Presence	Description and constraints
$	object	Root
alwaysUseDefaultValue	boolean	Required within parent	When true, always uses the default value even if a transaction-specific value is provided
defaultCurrencyCode	string	Required within parent	ISO 4217 currency code for the default value
defaultValue	number	Required within parent	Default monetary value assigned to each conversion

Upsert segment — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
countryCodes	array	Optional	Country codes
countryCodes[]	string	Each item
description	string	Optional	Segment description
expansionLevel	string	Optional	Expansion level One of: BALANCED, BROAD, NARROW
id	string	Optional	Segment identifier
members	array	Optional	Segment members — keywords, URLs, or apps that define the custom segment
members[]	Model	Each item	Expand Upsert segment — request body — body members item
membershipLifeSpan	number	Optional	Membership life span
membershipStatus	string	Optional	Membership status
name	string	Required within parent	Segment name
ruleBasedUserList	JSON	Optional	Rule-based user list config
ruleBasedUserList (allOf 1)	Model	All variants apply	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED
seedUserListIds	array	Optional	Seed user list IDs
seedUserListIds[]	string	Each item
status	string	Optional	Segment status
type	string	Optional	Segment type

Referenced models: Upsert segment — request body — body members item, Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED

Field	Type	Presence	Description and constraints
$	object	Root
flexibleRuleUserList	JSON	Required within parent	Flexible rule user list configuration
flexibleRuleUserList (allOf 1)	Model	All variants apply	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator
prepopulationStatus	string	Optional	Prepopulation status One of: REQUESTED

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator

Field	Type	Presence	Description and constraints
$	object	Root
exclusiveOperands	array	Required within parent	Exclusive rule operands
exclusiveOperands[]	Model	Each item	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item
inclusiveOperands	array	Required within parent	Inclusive rule operands
inclusiveOperands[]	Model	Each item	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item
inclusiveRuleOperator	string	Optional	Operator for combining inclusive operands

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item

Field	Type	Presence	Description and constraints
$	object	Root
lookbackWindowDays	number	Required within parent	Lookback window in days
rule	JSON	Required within parent	Rule definition
rule (allOf 1)	Model	All variants apply	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups

Field	Type	Presence	Description and constraints
$	object	Root
ruleItemGroups	array	Required within parent	List of rule item groups
ruleItemGroups[]	Model	Each item	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item

Field	Type	Presence	Description and constraints
$	object	Root
ruleItems	array	Required within parent	List of rule items
ruleItems[]	Model	Each item	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Rule item name One of: url__, referrer__
stringRuleItem	JSON	Required within parent	String rule item condition
stringRuleItem (allOf 1)	Model	All variants apply	Expand Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item string Rule Item operator, value

Referenced models: Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item string Rule Item operator, value

Upsert segment — request body — body / ruleBasedUserList / prepopulationStatus: REQUESTED flexible Rule User List exclusive Operands, inclusive Operands, inclusive Rule Operator exclusive Operands item rule rule Item Groups rule Item Groups item rule Items item string Rule Item operator, value

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

Upsert segment — request body — body members item

Field	Type	Presence	Description and constraints
$	object	Root
app	string	Optional	App identifier
keyword	string	Optional	Keyword value
memberType	string	Required within parent	Member type One of: KEYWORD, URL, APP
url	string	Optional	URL value