Example

POST/v1/contacts/

https://example.leadprosper.tech/go-high-level/v1/contacts

Create a contact.

Create contact will allow this fields. ex:

Fields	Types	Example
firstName	string	John
lastName	string	Deo
name	string	John Deo
email	string	[email protected]
phone	string	+1 888-888-8888
address1	long	Tonkawa Trail W
city	string	Austin
state	string	Texas
postalCode	string	45001
website	string(url)	https://www.google.com
timezone	string	America/Chihuahua
dnd	boolean	`true`
tags	array	`["tag1", "tag2"]`
customField	object	`{"3r6dEOnsApNaKIhnFM6u": "Value 1", "MgobCB14YMVKuE4Ka8p1": "Value 2"}`. Notes:`3r6dEOnsApNaKIhnFM6u` and `MgobCB14YMVKuE4Ka8p1` is a custom field id. You can find it using Custom Fields endpoints.
source	string	Public API

Validation:

Email or Phone are required to create contact

Authorization:

Provide your location api key (Bearer Token). You can find here

AUTHORIZATIONBearer Token

Token

<token>

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
    "email": "[email protected]",
    "phone": "+18887324197",
    "firstName": "John",
    "lastName": "Deo",
    "name": "John Deo",
    "dateOfBirth": "1990-09-25",
    "address1": "3535 1st St N",
    "city": "Dolomite",
    "state": "AL",
    "country": "US",
    "postalCode": "35061",
    "companyName": "DGS VolMAX",
    "website": "35061",
    "tags": [
        "aute consequat ad ea",
        "dolor sed"
    ],
    "source": "public api",
    "customField": {
        "__custom_field_id__": "exercitation"
    }
}

Example Request

curl

curl --location --request POST 'https://example.leadprosper.tech/go-high-level/v1/contacts' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
    "email": "[email protected]",
    "phone": "+18887324197",
    "firstName": "John",
    "lastName": "Deo",
    "name": "John Deo",
    "dateOfBirth": "1990-09-25",
    "address1": "3535 1st St N",
    "city": "Dolomite",
    "state": "AL",
    "country": "US",
    "postalCode": "35061",
    "companyName": "DGS VolMAX",
    "website": "35061",
    "tags": [
        "commodo",
        "veniam ut reprehenderit"
    ],
    "source": "public api",
    "customField": {
        "__custom_field_id__": "do in Lorem ut exercitation"
    }
}'

Example Responses

javascript

Successful response

{
  "contact": {
    "id": "ocQHyuzHvysMo5N5VsXc",
    "locationId": "C2QujeCh8ZnC7al2InWR",
    "email": "[email protected]",
    "emailLowerCase": "[email protected]",
    "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",
    "timezone": "Asia/Calcutta",
    "country": "DE",
    "source": "xyz form",
    "dateAdded": "2020-10-29T09:31:30.255Z",
    "customField": [
      {
        "id": "MgobCB14YMVKuE4Ka8p1",
        "value": "ea laboris consectetur elit sit"
      },
      {
        "id": "MgobCB14YMVKuE4Ka8p1",
        "value": "incididunt cupidatat nostrud qu"
      }
    ],
    "tags": [
      "laboris esse ut irure",
      "eiusmod exercitation irure ut"
    ],
    "__moreField__": "consequat"
  }
}

Bad Request. please contact support!

{
  "msg": "Bad Request"
}

Unauthorized

{
  "msg": "Unauthorized"
}

Unprocessable Entity

{
  "email or phone": {
    "message": "The email or phone field is mandatory.",
    "rule": "required"
  }
}

Content-Type

application/json