HighLevel · Schema

UpsertSegmentDTO

CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation

Properties

Name	Type	Description
name	string	Segment name
description	string	Segment description
members	array	Segment members — keywords, URLs, or apps that define the custom segment
status	string	Segment status
type	string	Segment type
id	string	Segment identifier
membershipStatus	string	Membership status
ruleBasedUserList	object	Rule-based user list config
membershipLifeSpan	number	Membership life span
seedUserListIds	array	Seed user list IDs
countryCodes	array	Country codes
expansionLevel	string	Expansion level

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-upsert-segment-dto-schema.json",
  "title": "UpsertSegmentDTO",
  "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/UpsertSegmentDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Segment name"
    },
    "description": {
      "type": "string",
      "description": "Segment description"
    },
    "members": {
      "description": "Segment members — keywords, URLs, or apps that define the custom segment",
      "type": "array",
      "items": {
        "$ref": "#/$defs/MemberDTO"
      }
    },
    "status": {
      "type": "string",
      "description": "Segment status"
    },
    "type": {
      "type": "string",
      "description": "Segment type"
    },
    "id": {
      "type": "string",
      "description": "Segment identifier"
    },
    "membershipStatus": {
      "type": "string",
      "description": "Membership status"
    },
    "ruleBasedUserList": {
      "description": "Rule-based user list config",
      "allOf": [
        {
          "$ref": "#/$defs/RuleBasedUserListDTO"
        }
      ]
    },
    "membershipLifeSpan": {
      "type": "number",
      "description": "Membership life span"
    },
    "seedUserListIds": {
      "description": "Seed user list IDs",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "countryCodes": {
      "description": "Country codes",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expansionLevel": {
      "type": "string",
      "description": "Expansion level",
      "enum": [
        "BALANCED",
        "BROAD",
        "NARROW"
      ]
    }
  },
  "required": [
    "name"
  ],
  "$defs": {
    "FlexibleRuleUserListDTO": {
      "type": "object",
      "properties": {
        "inclusiveRuleOperator": {
          "type": "string",
          "description": "Operator for combining inclusive operands"
        },
        "inclusiveOperands": {
          "description": "Inclusive rule operands",
          "type": "array",
          "items": {
            "$ref": "#/$defs/RuleOperandDTO"
          }
        },
        "exclusiveOperands": {
          "description": "Exclusive rule operands",
          "type": "array",
          "items": {
            "$ref": "#/$defs/RuleOperandDTO"
          }
        }
      },
      "required": [
        "inclusiveOperands",
        "exclusiveOperands"
      ]
    },
    "MemberDTO": {
      "type": "object",
      "properties": {
        "memberType": {
          "type": "string",
          "description": "Member type",
          "enum": [
            "KEYWORD",
            "URL",
            "APP"
          ]
        },
        "keyword": {
          "type": "string",
          "description": "Keyword value"
        },
        "url": {
          "type": "string",
          "description": "URL value"
        },
        "app": {
          "type": "string",
          "description": "App identifier"
        }
      },
      "required": [
        "memberType"
      ]
    },
    "RuleBasedUserListDTO": {
      "type": "object",
      "properties": {
        "prepopulationStatus": {
          "type": "string",
          "description": "Prepopulation status",
          "enum": [
            "REQUESTED"
          ]
        },
        "flexibleRuleUserList": {
          "description": "Flexible rule user list configuration",
          "allOf": [
            {
              "$ref": "#/$defs/FlexibleRuleUserListDTO"
            }
          ]
        }
      },
      "required": [
        "flexibleRuleUserList"
      ]
    },
    "RuleDTO": {
      "type": "object",
      "properties": {
        "ruleItemGroups": {
          "description": "List of rule item groups",
          "type": "array",
          "items": {
            "$ref": "#/$defs/RuleItemGroupDTO"
          }
        }
      },
      "required": [
        "ruleItemGroups"
      ]
    },
    "RuleItemDTO": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Rule item name",
          "enum": [
            "url__",
            "referrer__"
          ]
        },
        "stringRuleItem": {
          "description": "String rule item condition",
          "allOf": [
            {
              "$ref": "#/$defs/StringRuleItemDTO"
            }
          ]
        }
      },
      "required": [
        "name",
        "stringRuleItem"
      ]
    },
    "RuleItemGroupDTO": {
      "type": "object",
      "properties": {
        "ruleItems": {
          "description": "List of rule items",
          "type": "array",
          "items": {
            "$ref": "#/$defs/RuleItemDTO"
          }
        }
      },
      "required": [
        "ruleItems"
      ]
    },
    "RuleOperandDTO": {
      "type": "object",
      "properties": {
        "lookbackWindowDays": {
          "type": "number",
          "description": "Lookback window in days"
        },
        "rule": {
          "description": "Rule definition",
          "allOf": [
            {
              "$ref": "#/$defs/RuleDTO"
            }
          ]
        }
      },
      "required": [
        "lookbackWindowDays",
        "rule"
      ]
    },
    "StringRuleItemDTO": {
      "type": "object",
      "properties": {
        "operator": {
          "type": "string",
          "description": "Rule operator"
        },
        "value": {
          "type": "string",
          "description": "Rule value"
        }
      },
      "required": [
        "operator",
        "value"
      ]
    }
  }
}

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-segment-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.