# Create Contact POST https://services.leadconnectorhq.com/contacts/ Create a new contact ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `contacts.write` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "2023-02-21" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/contacts/": { "post": { "summary": "Create Contact", "operationId": "createContact", "description": "Create a new contact", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "2023-02-21" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactDto" } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactsSuccessfulResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "bearer": [ "contacts.write" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "CreateContactDto": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First name of the contact", "example": "Rosan", "nullable": true }, "lastName": { "type": "string", "description": "Last name of the contact", "example": "Deo", "nullable": true }, "name": { "type": "string", "description": "Full name of the contact", "example": "Rosan Deo", "nullable": true }, "email": { "type": "string", "description": "Email address of the contact", "example": "rosan@deos.com", "nullable": true }, "locationId": { "type": "string", "description": "Location Id the contact should be created under", "example": "ve9EPM428h8vShlRW1KT" }, "gender": { "type": "string", "description": "Gender of the contact", "example": "male" }, "phone": { "type": "string", "description": "Phone number of the contact", "example": "+1 888-888-8888", "nullable": true }, "address1": { "type": "string", "description": "Street address of the contact", "example": "3535 1st St N", "nullable": true }, "city": { "type": "string", "description": "City of the contact", "example": "Dolomite", "nullable": true }, "state": { "type": "string", "description": "State of the contact", "example": "AL", "nullable": true }, "postalCode": { "type": "string", "description": "Postal code of the contact", "example": "35061" }, "website": { "type": "string", "description": "Website URL of the contact", "example": "https://www.tesla.com", "nullable": true }, "timezone": { "type": "string", "description": "Timezone of the contact", "example": "America/Chihuahua", "nullable": true }, "dnd": { "type": "boolean", "description": "Whether Do Not Disturb is enabled for the contact", "example": true }, "dndSettings": { "description": "Per-channel DND settings for the contact", "example": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "allOf": [ { "type": "object", "properties": { "Call": { "description": "DND settings for phone calls", "example": { "status": "active", "message": "Do not call", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "Email": { "description": "DND settings for email", "example": { "status": "active", "message": "Do not email", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "SMS": { "description": "DND settings for SMS", "example": { "status": "active", "message": "Do not SMS", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "WhatsApp": { "description": "DND settings for WhatsApp", "example": { "status": "active", "message": "Do not WhatsApp", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "GMB": { "description": "DND settings for Google My Business", "example": { "status": "active", "message": "Do not contact via GMB", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "FB": { "description": "DND settings for Facebook", "example": { "status": "active", "message": "Do not contact via FB", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] } }, "title": "DndSettingsSchema" } ] }, "inboundDndSettings": { "description": "Inbound DND settings per channel for the contact", "example": { "all": { "status": "active", "message": "Do not contact me" } }, "allOf": [ { "type": "object", "properties": { "all": { "description": "Inbound DND settings applied to all channels", "example": { "status": "active", "message": "Do not contact me" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Inbound DND status for this channel", "enum": [ "active", "inactive" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the inbound DND setting", "example": "Please do not contact me via this channel" } }, "required": [ "status" ], "title": "InboundDndSettingSchema" } ] } }, "title": "InboundDndSettingsSchema" } ] }, "tags": { "description": "List of tags to assign to the contact", "example": [ "nisi sint commodo amet", "consequat" ], "type": "array", "items": { "type": "string" } }, "customFields": { "type": "array", "description": "List of custom field values to assign to the contact", "example": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "string", "description": "Text value for the custom field (preferred).", "example": "My Text" }, "field_value": { "type": "string", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": "My Text" } }, "required": [ "id" ], "title": "TextField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "string", "description": "Large text value for the custom field (preferred).", "example": "My Text" }, "field_value": { "type": "string", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": "My Text" } }, "required": [ "id" ], "title": "LargeTextField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "string", "description": "Selected option value for the custom field (preferred).", "example": "My Selected Option" }, "field_value": { "type": "string", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": "My Selected Option" } }, "required": [ "id" ], "title": "SingleSelectField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "string", "description": "Selected radio option value for the custom field (preferred).", "example": "My Selected Option" }, "field_value": { "type": "string", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": "My Selected Option" } }, "required": [ "id" ], "title": "RadioField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "object", "description": "Numeric value for the custom field (preferred).", "example": 100 }, "field_value": { "type": "object", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": 100 } }, "required": [ "id" ], "title": "NumericField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "object", "description": "Monetary value for the custom field (preferred).", "example": 100.5 }, "field_value": { "type": "object", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": 100.5 } }, "required": [ "id" ], "title": "MonetoryField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "description": "Array of selected checkbox values for the custom field (preferred).", "example": [ "test", "test2" ], "type": "array", "items": { "type": "string" } }, "field_value": { "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": [ "test", "test2" ], "type": "array", "items": { "type": "string" } } }, "required": [ "id" ], "title": "CheckboxField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "description": "Array of selected values for the custom field (preferred).", "example": [ "test", "test2" ], "type": "array", "items": { "type": "string" } }, "field_value": { "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": [ "test", "test2" ], "type": "array", "items": { "type": "string" } } }, "required": [ "id" ], "title": "MultiSelectField" }, { "type": "object", "properties": { "id": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "6dvNaf7VhkQ9snc5vnjJ" }, "key": { "type": "string", "description": "Pass either `id` or `key` of custom field", "example": "my_custom_field" }, "fieldValue": { "type": "object", "description": "File upload value — a map of UUID to file metadata and download URL (preferred).", "example": { "f31175d4-2b06-4fc6-b7bc-74cd814c68cb": { "meta": { "fieldname": "1HeGizb13P0odwgOgKSs", "originalname": "IMG_20231215_164412935.jpg", "encoding": "7bit", "mimetype": "image/jpeg", "size": 1786611, "uuid": "f31175d4-2b06-4fc6-b7bc-74cd814c68cb" }, "url": "https://services.leadconnectorhq.com/documents/download/w2M9qTZ0ZJz8rGt02jdJ", "documentId": "w2M9qTZ0ZJz8rGt02jdJ" } } }, "field_value": { "type": "object", "deprecated": true, "description": "Deprecated. Use `fieldValue` instead.", "example": { "f31175d4-2b06-4fc6-b7bc-74cd814c68cb": { "meta": { "fieldname": "1HeGizb13P0odwgOgKSs", "originalname": "IMG_20231215_164412935.jpg", "encoding": "7bit", "mimetype": "image/jpeg", "size": 1786611, "uuid": "f31175d4-2b06-4fc6-b7bc-74cd814c68cb" }, "url": "https://services.leadconnectorhq.com/documents/download/w2M9qTZ0ZJz8rGt02jdJ", "documentId": "w2M9qTZ0ZJz8rGt02jdJ" } } } }, "required": [ "id" ], "title": "FileField" } ] } }, "source": { "type": "string", "description": "Source from which the contact was created", "example": "public api" }, "dateOfBirth": { "type": "object", "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", "example": "1990-09-25", "nullable": true }, "country": { "type": "string", "description": "Country code of the contact (ISO 3166-1 alpha-2)", "example": "US" }, "companyName": { "type": "string", "description": "Company name of the contact", "example": "DGS VolMAX", "nullable": true }, "assignedTo": { "type": "string", "example": "y0BeYjuRIlDwsDcOHOJo", "description": "User's Id" }, "additionalEmails": { "description": "Add additional email addresses to a contact.\n\n> ⚠️ **Important:** When sending `additionalEmails`, you must also include the contact’s current primary `email` in the same request.
If you send `additionalEmails` without `email`, the contact’s existing primary email may be cleared or replaced.\n\n\n\nExample\n\n```json\n{\n \"email\": \"john@example.com\",\n \"additionalEmails\": [\n {\n \"email\": \"john.work@example.com\"\n }\n ]\n}\n```\n\nAvoid\n\n```json\n{\n \"additionalEmails\": [\n {\n \"email\": \"john.work@example.com\"\n }\n ]\n}\n```\n\nSending only `additionalEmails` may cause the existing primary email to be lost.\n\nIf email uniqueness is enabled for the location, every email address in the request—primary and additional—must be unique across contacts. If any email already belongs to another contact, the request fails with **400 Bad Request** and no changes are saved.", "maxItems": 10, "example": [ { "email": "rosan@deos.com" } ], "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "example": "rosan@deos.com", "description": "Additional Email" } }, "required": [ "email" ], "title": "ContactsAdditionalEmailsPayloadDto" } }, "additionalPhones": { "description": "Add additional phone numbers to a contact.\n\n> ⚠️ **Important:** When sending `additionalPhones`, you must also include the contact’s current primary `phone` in the same request.
If you send `additionalPhones` without `phone`, the contact’s existing primary phone may be cleared or replaced.\n\n\n\nExample\n\n```json\n{\n \"phone\": \"+14155550100\",\n \"additionalPhones\": [\n {\n \"phone\": \"+14155550101\",\n \"phoneLabel\": \"Work\"\n }\n ]\n}\n```\n\nAvoid\n\n```json\n{\n \"additionalPhones\": [\n {\n \"phone\": \"+14155550101\",\n \"phoneLabel\": \"Work\"\n }\n ]\n}\n```\n\nSending only `additionalPhones` may cause the existing primary phone number to be lost.\n\nIf phone uniqueness is enabled for the location, every phone number in the request—primary and additional—must be unique across contacts. If any phone number already belongs to another contact, the request fails with **400 Bad Request** and no changes are saved.", "maxItems": 10, "example": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ], "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "example": "7017345098", "description": "Additional Phones" }, "phoneLabel": { "type": "string", "description": "Label", "enum": [ "Home", "Work", "Mobile", "Landline" ], "example": "Mobile" } }, "required": [ "phone" ], "title": "ContactsAdditionalPhonesPayloadDto" } } }, "required": [ "locationId" ], "title": "CreateContactDto" }, "CreateContactsSuccessfulResponseDto": { "type": "object", "properties": { "contact": { "description": "The newly created contact", "example": { "id": "seD4PfOuKoVMLkEZqohJ", "firstName": "Rosan", "lastName": "Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "dateAdded": "2021-08-31T09:59:41.937Z" }, "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the contact", "example": "seD4PfOuKoVMLkEZqohJ" }, "dateAdded": { "type": "string", "description": "Date and time the contact was added (ISO 8601)", "example": "2021-08-31T09:59:41.937Z" }, "dateUpdated": { "type": "string", "description": "Date and time the contact was last updated (ISO 8601)", "example": "2021-08-31T09:59:41.937Z" }, "deleted": { "type": "boolean", "description": "Whether the contact has been deleted", "example": false }, "tags": { "description": "List of tags associated with the contact", "example": [ "nisi sint commodo amet", "consequat" ], "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "description": "Contact type classification if absent then default will be the first value available under contact type options", "example": "lead" }, "customFields": { "description": "List of custom field values for the contact", "example": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "value": "My Text" } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the custom field", "example": "MgobCB14YMVKuE4Ka8p1" }, "value": { "type": "string", "description": "Value of the custom field", "example": "name" } }, "title": "CustomFieldSchema" } }, "locationId": { "type": "string", "description": "Location Id the contact belongs to", "example": "ve9EPM428h8vShlRW1KT" }, "firstName": { "type": "string", "description": "First name of the contact", "example": "rubika" }, "firstNameLowerCase": { "type": "string", "description": "Lowercase version of the contact first name", "example": "rubika" }, "fullNameLowerCase": { "type": "string", "description": "Lowercase version of the contact full name", "example": "rubika deo" }, "lastName": { "type": "string", "description": "Last name of the contact", "example": "Deo" }, "lastNameLowerCase": { "type": "string", "description": "Lowercase version of the contact last name", "example": "deo" }, "email": { "type": "string", "description": "Email address of the contact", "example": "rubika@deos.com" }, "emailLowerCase": { "type": "string", "description": "Lowercase version of the contact email", "example": "rubika@deos.com" }, "bounceEmail": { "type": "boolean", "description": "Whether the contact email has bounced", "example": false }, "unsubscribeEmail": { "type": "boolean", "description": "Whether the contact has unsubscribed from email", "example": false }, "dnd": { "type": "boolean", "description": "Whether Do Not Disturb is enabled for the contact", "example": true }, "dndSettings": { "description": "Per-channel DND settings for the contact", "example": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "allOf": [ { "type": "object", "properties": { "Call": { "description": "DND settings for phone calls", "example": { "status": "active", "message": "Do not call", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "Email": { "description": "DND settings for email", "example": { "status": "active", "message": "Do not email", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "SMS": { "description": "DND settings for SMS", "example": { "status": "active", "message": "Do not SMS", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "WhatsApp": { "description": "DND settings for WhatsApp", "example": { "status": "active", "message": "Do not WhatsApp", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "GMB": { "description": "DND settings for Google My Business", "example": { "status": "active", "message": "Do not contact via GMB", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] }, "FB": { "description": "DND settings for Facebook", "example": { "status": "active", "message": "Do not contact via FB", "code": "all" }, "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Do Not Disturb status for this channel", "enum": [ "active", "inactive", "permanent" ], "example": "active" }, "message": { "type": "string", "description": "Custom message associated with the DND setting", "example": "Do not contact via this channel" }, "code": { "type": "string", "description": "DND code or reason", "example": "OPTED_OUT" } }, "required": [ "status" ], "title": "DndSettingSchema" } ] } }, "title": "DndSettingsSchema" } ] }, "phone": { "type": "string", "description": "Phone number of the contact", "example": "+18832327657" }, "address1": { "type": "string", "description": "Street address of the contact", "example": "3535 1st St N" }, "city": { "type": "string", "description": "City of the contact", "example": "Birmingham" }, "state": { "type": "string", "description": "State of the contact", "example": "AL" }, "country": { "type": "string", "description": "Country of the contact , Refer country list from documentaion, documentation has list of all countries", "example": "US" }, "postalCode": { "type": "string", "description": "Postal code of the contact", "example": "35061" }, "website": { "type": "string", "description": "Website URL of the contact", "example": "https://www.tesla.com" }, "source": { "type": "string", "description": "Source from which the contact was created", "example": "public api" }, "companyName": { "type": "string", "description": "Company name of the contact", "example": "DGS VolMAX" }, "dateOfBirth": { "type": "string", "description": "Date of birth of the contact (ISO 8601 format)", "example": "1990-09-25T00:00:00.000Z" }, "birthMonth": { "type": "number", "description": "Birth month of the contact (1-12)", "example": 8 }, "birthDay": { "type": "number", "description": "Birth day of the contact (1-31)", "example": 25 }, "lastSessionActivityAt": { "type": "string", "description": "Timestamp of the last session activity (ISO 8601)", "example": "2021-07-16T11:39:30.564Z" }, "offers": { "description": "List of offer Ids associated with the contact", "example": [], "type": "array", "items": { "type": "string" } }, "products": { "description": "List of product Ids associated with the contact", "example": [], "type": "array", "items": { "type": "string" } }, "businessId": { "type": "string", "description": "Business Id the contact is associated with", "example": "641c094001436dbc2081e642" }, "assignedTo": { "type": "string", "example": "y0BeYjuRIlDwsDcOHOJo", "description": "User's Id" } }, "title": "CreateContactSchema" } ] } }, "title": "CreateContactsSuccessfulResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## HighLevel SDK Examples **Node.js** (`@gohighlevel/api-client`) ```javascript import HighLevel from '@gohighlevel/api-client'; const ghl = new HighLevel({ privateIntegrationToken: '' }); const body = { "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }; const response = await ghl.contacts.createContact(body); console.log(response); ``` **Python** (`gohighlevel-api-client`) ```python from highlevel import HighLevel client = HighLevel( private_integration_token='' ) body = { "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] } response = await client.contacts.create_contact(body=body) print(response) ``` **PHP** (`gohighlevel/api-client`) ```php '' ]); $ghl = new HighLevel($config); $body = [ 'firstName' => 'Rosan', 'lastName' => 'Deo', 'name' => 'Rosan Deo', 'email' => 'rosan@deos.com', 'locationId' => 've9EPM428h8vShlRW1KT', 'gender' => 'male', 'phone' => '+1 888-888-8888', 'address1' => '3535 1st St N', 'city' => 'Dolomite', 'state' => 'AL', 'postalCode' => '35061', 'website' => 'https://www.tesla.com', 'timezone' => 'America/Chihuahua', 'dnd' => true, 'dndSettings' => [ 'Call' => [ 'status' => 'active', 'message' => 'Do not call' ], 'Email' => [ 'status' => 'inactive' ] ], 'inboundDndSettings' => [ 'all' => [ 'status' => 'active', 'message' => 'Do not contact me' ] ], 'tags' => [ 'nisi sint commodo amet', 'consequat' ], 'customFields' => [ [ 'id' => '6dvNaf7VhkQ9snc5vnjJ', 'key' => 'my_custom_field', 'fieldValue' => 'My Text' ] ], 'source' => 'public api', 'dateOfBirth' => '1990-09-25', 'country' => 'US', 'companyName' => 'DGS VolMAX', 'assignedTo' => 'y0BeYjuRIlDwsDcOHOJo', 'additionalEmails' => [ [ 'email' => 'rosan@deos.com' ] ], 'additionalPhones' => [ [ 'phone' => '+18832327657', 'phoneLabel' => 'Mobile' ] ] ]; $response = $ghl->contacts->createContact($body); echo json_encode($response, JSON_PRETTY_PRINT); ``` ## Code Examples **cURL** ```bash curl -L -X POST 'https://services.leadconnectorhq.com/contacts/' \ -H 'Authorization: Bearer ' \ -H 'Version: 2023-02-21' \ -H 'Content-Type: application/json' \ --data-raw '{ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }' ``` **Node.js** ```javascript const options = { method: 'POST', headers: { Authorization: 'Bearer ', Version: '2023-02-21', 'Content-Type': 'application/json' }, body: JSON.stringify({ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }) }; try { const response = await fetch('https://services.leadconnectorhq.com/contacts/', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/contacts/" headers = { "Authorization": "Bearer ", "Version": "2023-02-21" } payload = { "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/contacts/', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: 2023-02-21', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }', ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .post("https://services.leadconnectorhq.com/contacts/") .header("Authorization", "Bearer ") .header("Version", "2023-02-21") .header("Content-Type", "application/json") .body("{\"firstName\":\"Rosan\",\"lastName\":\"Deo\",\"name\":\"Rosan Deo\",\"email\":\"rosan@deos.com\",\"locationId\":\"ve9EPM428h8vShlRW1KT\",\"gender\":\"male\",\"phone\":\"+1 888-888-8888\",\"address1\":\"3535 1st St N\",\"city\":\"Dolomite\",\"state\":\"AL\",\"postalCode\":\"35061\",\"website\":\"https://www.tesla.com\",\"timezone\":\"America/Chihuahua\",\"dnd\":true,\"dndSettings\":{\"Call\":{\"status\":\"active\",\"message\":\"Do not call\"},\"Email\":{\"status\":\"inactive\"}},\"inboundDndSettings\":{\"all\":{\"status\":\"active\",\"message\":\"Do not contact me\"}},\"tags\":[\"nisi sint commodo amet\",\"consequat\"],\"customFields\":[{\"id\":\"6dvNaf7VhkQ9snc5vnjJ\",\"key\":\"my_custom_field\",\"fieldValue\":\"My Text\"}],\"source\":\"public api\",\"dateOfBirth\":\"1990-09-25\",\"country\":\"US\",\"companyName\":\"DGS VolMAX\",\"assignedTo\":\"y0BeYjuRIlDwsDcOHOJo\",\"additionalEmails\":[{\"email\":\"rosan@deos.com\"}],\"additionalPhones\":[{\"phone\":\"+18832327657\",\"phoneLabel\":\"Mobile\"}]}") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" "strings" ) func main() { url := "https://services.leadconnectorhq.com/contacts/" payload := strings.NewReader(`{ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }`) req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "2023-02-21") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/contacts/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = "Bearer " request["Version"] = "2023-02-21" request["Content-Type"] = "application/json" request.body = '{ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }' response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "2023-02-21" } $body = '{ "firstName": "Rosan", "lastName": "Deo", "name": "Rosan Deo", "email": "rosan@deos.com", "locationId": "ve9EPM428h8vShlRW1KT", "gender": "male", "phone": "+1 888-888-8888", "address1": "3535 1st St N", "city": "Dolomite", "state": "AL", "postalCode": "35061", "website": "https://www.tesla.com", "timezone": "America/Chihuahua", "dnd": true, "dndSettings": { "Call": { "status": "active", "message": "Do not call" }, "Email": { "status": "inactive" } }, "inboundDndSettings": { "all": { "status": "active", "message": "Do not contact me" } }, "tags": [ "nisi sint commodo amet", "consequat" ], "customFields": [ { "id": "6dvNaf7VhkQ9snc5vnjJ", "key": "my_custom_field", "fieldValue": "My Text" } ], "source": "public api", "dateOfBirth": "1990-09-25", "country": "US", "companyName": "DGS VolMAX", "assignedTo": "y0BeYjuRIlDwsDcOHOJo", "additionalEmails": [ { "email": "rosan@deos.com" } ], "additionalPhones": [ { "phone": "+18832327657", "phoneLabel": "Mobile" } ] }' $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/contacts/' -Method 'POST' -Headers $headers -Body $body -ContentType 'application/json' $response | ConvertTo-Json ```