HighLevel · Schema

UpsertAdDTO

CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation

Properties

Name Type Description
id string Ad identifier
locationId string Location identifier
name string Ad name
primaryText string Ad primary text
headline string Ad headline text
description string Ad description text
imageUrl string Ad image URL
mediaType string Ad media type
media array Media items (images or videos) attached to the ad creative
multiAdvertiserAds boolean Enable multi-advertiser ads
campaignId string Parent campaign ID
adsetId string Parent ad set ID
cta string Call to action type
conversationFormId string Conversation form ID
destinationLink string Destination link URL
destinationFormId string Destination form ID
View JSON Schema on GitHub

JSON Schema

highlevel-upsert-ad-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-upsert-ad-dto-schema.json",
  "title": "UpsertAdDTO",
  "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/UpsertAdDTO",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Ad identifier"
    },
    "locationId": {
      "type": "string",
      "description": "Location identifier"
    },
    "name": {
      "type": "string",
      "description": "Ad name"
    },
    "primaryText": {
      "type": "string",
      "description": "Ad primary text"
    },
    "headline": {
      "type": "string",
      "description": "Ad headline text"
    },
    "description": {
      "type": "string",
      "description": "Ad description text"
    },
    "imageUrl": {
      "type": "string",
      "description": "Ad image URL"
    },
    "mediaType": {
      "type": "string",
      "description": "Ad media type",
      "enum": [
        "SINGLE",
        "CAROUSEL"
      ]
    },
    "media": {
      "description": "Media items (images or videos) attached to the ad creative",
      "type": "array",
      "items": {
        "$ref": "#/$defs/MediaDTO"
      }
    },
    "multiAdvertiserAds": {
      "type": "boolean",
      "description": "Enable multi-advertiser ads"
    },
    "campaignId": {
      "type": "string",
      "description": "Parent campaign ID"
    },
    "adsetId": {
      "type": "string",
      "description": "Parent ad set ID"
    },
    "cta": {
      "type": "string",
      "description": "Call to action type"
    },
    "conversationFormId": {
      "type": "string",
      "description": "Conversation form ID"
    },
    "destinationLink": {
      "type": "string",
      "description": "Destination link URL"
    },
    "destinationFormId": {
      "type": "string",
      "description": "Destination form ID"
    }
  },
  "required": [
    "locationId",
    "campaignId",
    "adsetId"
  ],
  "$defs": {
    "MediaDTO": {
      "type": "object",
      "properties": {
        "src": {
          "type": "string",
          "description": "Media source URL"
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "Thumbnail URL (required when type is video)"
        },
        "selectedPoster": {
          "type": "number",
          "description": "Selected poster index (required when type is video)"
        },
        "type": {
          "type": "string",
          "description": "Media content type",
          "enum": [
            "image",
            "video"
          ]
        },
        "name": {
          "type": "string",
          "description": "Media file name"
        },
        "headline": {
          "type": "string",
          "description": "Media headline"
        },
        "description": {
          "type": "string",
          "description": "Media description"
        },
        "link": {
          "type": "string",
          "description": "Media destination link"
        }
      },
      "required": [
        "src",
        "type"
      ]
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/highlevel-upsert-ad-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.