HighLevel · Schema
UpsertContactDto
CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation
Properties
| Name | Type | Description |
|---|---|---|
| firstName | stringnull | |
| lastName | stringnull | |
| name | stringnull | |
| stringnull | ||
| locationId | string | |
| gender | string | |
| phone | stringnull | |
| address1 | stringnull | |
| city | stringnull | |
| state | stringnull | |
| postalCode | string | |
| website | stringnull | |
| timezone | stringnull | |
| dnd | boolean | |
| dndSettings | object | |
| inboundDndSettings | object | |
| tags | array | This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead. |
| customFields | array | |
| source | string | |
| dateOfBirth | objectnull | The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY |
| country | string | |
| companyName | stringnull | |
| assignedTo | string | User's Id |
| createNewIfDuplicateAllowed | boolean | Controls whether to create a new contact or update an existing duplicate. **Scenario 1:** If this value is `true` and the location allows duplicate contacts, a new contact will be created immediately |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-upsert-contact-dto-schema.json",
"title": "UpsertContactDto",
"x-generated": "2026-09-22",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/_original/highlevel-contacts-openapi.json#/components/schemas/UpsertContactDto",
"type": "object",
"properties": {
"firstName": {
"type": [
"string",
"null"
]
},
"lastName": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"locationId": {
"type": "string"
},
"gender": {
"type": "string"
},
"phone": {
"type": [
"string",
"null"
]
},
"address1": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"postalCode": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"dnd": {
"type": "boolean"
},
"dndSettings": {
"$ref": "#/$defs/DndSettingsSchema"
},
"inboundDndSettings": {
"$ref": "#/$defs/InboundDndSettingsSchema"
},
"tags": {
"description": "This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.",
"type": "array",
"items": {
"type": "string"
}
},
"customFields": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/$defs/TextField"
},
{
"$ref": "#/$defs/LargeTextField"
},
{
"$ref": "#/$defs/SingleSelectField"
},
{
"$ref": "#/$defs/RadioField"
},
{
"$ref": "#/$defs/NumericField"
},
{
"$ref": "#/$defs/MonetoryField"
},
{
"$ref": "#/$defs/CheckboxField"
},
{
"$ref": "#/$defs/MultiSelectField"
},
{
"$ref": "#/$defs/FileField"
}
]
}
},
"source": {
"type": "string"
},
"dateOfBirth": {
"type": [
"object",
"null"
],
"description": "The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY"
},
"country": {
"type": "string"
},
"companyName": {
"type": [
"string",
"null"
]
},
"assignedTo": {
"type": "string",
"description": "User's Id"
},
"createNewIfDuplicateAllowed": {
"type": "boolean",
"description": "Controls whether to create a new contact or update an existing duplicate. **Scenario 1:** If this value is `true` and the location allows duplicate contacts, a new contact will be created immediately without checking for duplicates. **Scenario 2:** If this value is `true` but the location does not allow duplicate contacts, this field is ignored and the normal upsert behavior applies: the API will search for an existing duplicate contact, update it if found, or create a new contact if not found. **Scenario 3:** If this value is `false` or not provided, the normal upsert behavior applies regardless of the location's duplicate contact setting.",
"default": false
}
},
"required": [
"locationId"
],
"$defs": {
"CheckboxField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id"
]
},
"DndSettingSchema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"permanent"
]
},
"message": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"status"
]
},
"DndSettingsSchema": {
"type": "object",
"properties": {
"Call": {
"$ref": "#/$defs/DndSettingSchema"
},
"Email": {
"$ref": "#/$defs/DndSettingSchema"
},
"SMS": {
"$ref": "#/$defs/DndSettingSchema"
},
"WhatsApp": {
"$ref": "#/$defs/DndSettingSchema"
},
"GMB": {
"$ref": "#/$defs/DndSettingSchema"
},
"FB": {
"$ref": "#/$defs/DndSettingSchema"
}
}
},
"FileField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "object"
}
},
"required": [
"id"
]
},
"InboundDndSettingSchema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"message": {
"type": "string"
}
},
"required": [
"status"
]
},
"InboundDndSettingsSchema": {
"type": "object",
"properties": {
"all": {
"$ref": "#/$defs/InboundDndSettingSchema"
}
}
},
"LargeTextField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "string"
}
},
"required": [
"id"
]
},
"MonetoryField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "object"
}
},
"required": [
"id"
]
},
"MultiSelectField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id"
]
},
"NumericField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "object"
}
},
"required": [
"id"
]
},
"RadioField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "string"
}
},
"required": [
"id"
]
},
"SingleSelectField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "string"
}
},
"required": [
"id"
]
},
"TextField": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"field_value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}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-contact-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.