HighLevel · Schema
UpsertAdsetDTO
CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Ad set identifier |
| locationId | string | Location identifier |
| name | string | Ad set name |
| pageId | string | Facebook page ID |
| instagramActorId | string | Instagram actor ID |
| messagingPlatforms | string | Messaging platforms |
| whatsappNumber | string | WhatsApp phone number |
| audience | object | Targeting audience configuration including geo-locations, locales, placements, and custom audiences |
| budget | object | Ad set budget config |
| conversionLocation | string | Conversion location |
| customEventType | string | Custom event type |
| pixelId | string | Conversion pixel ID |
| campaignId | string | Parent campaign ID |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-upsert-adset-dto-schema.json",
"title": "UpsertAdsetDTO",
"x-generated": "2026-09-22",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/_original/highlevel-ad-manager-openapi.json#/components/schemas/UpsertAdsetDTO",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Ad set identifier"
},
"locationId": {
"type": "string",
"description": "Location identifier"
},
"name": {
"type": "string",
"description": "Ad set name"
},
"pageId": {
"type": "string",
"description": "Facebook page ID"
},
"instagramActorId": {
"type": "string",
"description": "Instagram actor ID"
},
"messagingPlatforms": {
"type": "string",
"description": "Messaging platforms",
"enum": [
"WHATSAPP",
"MESSENGER",
"INSTAGRAM_DIRECT"
]
},
"whatsappNumber": {
"type": "string",
"description": "WhatsApp phone number"
},
"audience": {
"description": "Targeting audience configuration including geo-locations, locales, placements, and custom audiences",
"allOf": [
{
"$ref": "#/$defs/FacebookAudienceDTO"
}
]
},
"budget": {
"description": "Ad set budget config",
"allOf": [
{
"$ref": "#/$defs/Budget"
}
]
},
"conversionLocation": {
"type": "string",
"description": "Conversion location"
},
"customEventType": {
"type": "string",
"description": "Custom event type"
},
"pixelId": {
"type": "string",
"description": "Conversion pixel ID"
},
"campaignId": {
"type": "string",
"description": "Parent campaign ID"
}
},
"required": [
"locationId",
"campaignId"
],
"$defs": {
"AudienceCustomAudienceItemDTO": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Custom audience ID"
},
"name": {
"type": "string",
"description": "Custom audience name"
}
},
"required": [
"id",
"name"
]
},
"AudienceInterestDTO": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Interest ID"
},
"name": {
"type": "string",
"description": "Interest name"
},
"type": {
"type": "string",
"description": "Interest category type (defaults to \"interests\" if omitted)"
}
},
"required": [
"id",
"name"
]
},
"AudienceLocaleDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Locale display name"
},
"key": {
"type": "number",
"description": "Facebook locale key"
}
},
"required": [
"name",
"key"
]
},
"AudienceLocationDTO": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Facebook location key"
},
"name": {
"type": "string",
"description": "Location display name"
},
"type": {
"type": "string",
"description": "Geographic location type",
"enum": [
"country",
"city",
"region",
"country_group",
"geo_market",
"large_geo_area",
"medium_geo_area",
"small_geo_area",
"subcity",
"neighborhood",
"zip",
"address"
]
},
"selectionType": {
"type": "string",
"description": "Whether the location is included or excluded from targeting",
"enum": [
"include",
"exclude"
]
},
"radius": {
"type": "number",
"description": "Targeting radius around the location (for city/address types)"
},
"radiusUnit": {
"type": "string",
"description": "Unit for the targeting radius",
"enum": [
"km",
"mi"
]
},
"geometry": {
"description": "Geometry data for address-based targeting",
"allOf": [
{
"$ref": "#/$defs/AudienceLocationGeometry"
}
]
}
},
"required": [
"key",
"name",
"type",
"selectionType"
]
},
"AudienceLocationGeometry": {
"type": "object",
"properties": {
"location": {
"type": "object",
"description": "Geographic coordinates"
},
"location_type": {
"type": "string",
"description": "Geocoding result type"
}
},
"required": [
"location",
"location_type"
]
},
"AudiencePlacementsDTO": {
"type": "object",
"properties": {
"facebook": {
"description": "Facebook placement positions",
"type": "array",
"items": {
"type": "string"
}
},
"instagram": {
"description": "Instagram placement positions",
"type": "array",
"items": {
"type": "string"
}
},
"messenger": {
"description": "Messenger placement positions",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Budget": {
"type": "object",
"properties": {
"budgetType": {
"type": "string",
"description": "Budget type",
"enum": [
"DAILY",
"LIFETIME"
]
},
"amount": {
"type": "number",
"description": "Budget amount"
},
"scheduleStartDate": {
"type": "string",
"description": "Schedule start date"
},
"scheduleEndDate": {
"type": "string",
"description": "Schedule end date"
}
},
"required": [
"budgetType",
"amount"
]
},
"FacebookAudienceDTO": {
"type": "object",
"properties": {
"geo_locations": {
"description": "Geographic locations to target or exclude",
"type": "array",
"items": {
"$ref": "#/$defs/AudienceLocationDTO"
}
},
"locales": {
"description": "Language locales to target",
"type": "array",
"items": {
"$ref": "#/$defs/AudienceLocaleDTO"
}
},
"placements": {
"description": "Ad placement positions per platform (only used when placementType is \"manual\")",
"allOf": [
{
"$ref": "#/$defs/AudiencePlacementsDTO"
}
]
},
"placementType": {
"type": "string",
"description": "Placement strategy — \"auto\" lets Facebook choose, \"manual\" uses the placements config",
"enum": [
"auto",
"manual"
]
},
"lookalike": {
"description": "Lookalike audiences to target",
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCustomAudienceItemDTO"
}
},
"retargeting": {
"description": "Retargeting custom audiences to target",
"type": "array",
"items": {
"$ref": "#/$defs/AudienceCustomAudienceItemDTO"
}
},
"interests": {
"description": "Interest-based targeting criteria",
"type": "array",
"items": {
"$ref": "#/$defs/AudienceInterestDTO"
}
},
"age_min": {
"type": "number",
"description": "Minimum age for targeting"
},
"age_max": {
"type": "number",
"description": "Maximum age for targeting"
},
"genders": {
"description": "Gender targeting (1 = male, 2 = female)",
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"geo_locations"
]
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/highlevel-upsert-adset-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.