Create Contact

Create a new contact in a sub-account. At minimum you should provide an email or phone number.

POST/contacts/

Scope

contacts.write

Auth Method

Bearer Token

Token Type

Sub-Account / Company

Header Parameters

Parameter	Type	Description
`Authorization`required	string	Bearer {access_token}
`Version`required	string	API Version Possible values: `2021-07-28`
`Content-Type`required	string	application/json

Body Parameters

Parameter	Type	Description
`firstName`	string	First name of the contact.
`lastName`	string	Last name of the contact.
`name`	string	Full name of the contact (alternative to firstName + lastName).
`email`	string	Email address. Either email or phone is recommended.
`locationId`required	string	The sub-account ID where the contact will be created.
`phone`	string	Phone number in E.164 format (e.g. +15551234567).
`address1`	string	Street address line 1.
`city`	string	City name.
`state`	string	State or province.
`postalCode`	string	ZIP or postal code.
`country`	string	Country code (ISO 3166-1 alpha-2). See the country list for accepted values.
`website`	string	Website URL.
`timezone`	string	IANA timezone string (e.g. America/Chicago).
`dnd`	boolean	Global Do Not Disturb flag.
`dndSettings`	object	Per-channel DND settings. Keys: Call, Email, SMS, WhatsApp, GMB, FB.
`tags`	string[]	Array of tag names to assign to the contact.
`customFields`	object[]	Array of custom field objects: { "id": "field_id", "value": "field_value" }.
`source`	string	Lead source identifier.
`companyName`	string	Company or business name.
`dateOfBirth`	string	Birth date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY.
`assignedTo`	string	User ID to assign the contact to.

Example RequestcURL

curl -X POST \
  'https://services.leadconnectorhq.com/contacts/' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "phone": "+15551234567",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "tags": ["new-lead", "website"],
    "source": "api",
    "companyName": "Smith Co",
    "address1": "456 Oak Ave",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78702",
    "country": "US",
    "timezone": "America/Chicago"
  }'

Response — 201 Created

Example ResponseJSON

{
  "contact": {
    "id": "ocQHyuzHvuMOe5N5jjXF",
    "firstName": "Jane",
    "lastName": "Smith",
    "name": "Jane Smith",
    "email": "[email protected]",
    "phone": "+15551234567",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "tags": ["new-lead", "website"],
    "source": "api",
    "companyName": "Smith Co",
    "address1": "456 Oak Ave",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78702",
    "country": "US",
    "timezone": "America/Chicago",
    "dateAdded": "2024-06-15T10:00:00.000Z",
    "dateUpdated": "2024-06-15T10:00:00.000Z"
  }
}

← Get Contact Update Contact →