Please find the list of acceptable values for the country field here

http
POST https://services.leadconnectorhq.com/contacts/

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Body

NameTypeRequiredExampleDescription
firstNamestringNoRosan
lastNamestringNoDeo
namestringNoRosan Deo
emailstringNorosan@deos.com
locationIdstringYesve9EPM428h8vShlRW1KT
genderstringNomale
phonestringNo+1 888-888-8888
address1stringNo3535 1st St N
citystringNoDolomite
statestringNoAL
postalCodestringNo35061
websitestringNohttps://www.tesla.com
timezonestringNoAmerica/Chihuahua
dndbooleanNoTrue
  • dndSettings (object)

    • Call (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

    • Email (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

    • SMS (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

    • WhatsApp (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

    • GMB (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

    • FB (object)

      • status (string, required): Possible values: 'active', 'inactive', 'permanent'

      • message (string)

      • code (string)

  • inboundDndSettings (object)

    • all (object)

      • status (string, required): Possible values: 'active', 'inactive'

      • message (string)

NameTypeRequiredExampleDescription
tagsstring[]No
customFieldsobject[]No
sourcestringNopublic api
dateOfBirthobjectNo1990-09-25The 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
countrystringNoUS
companyNamestringNoDGS VolMAX
assignedTostringNoy0BeYjuRIlDwsDcOHOJoUser's Id

Responses

201 - Successful response
  • contact (object)

    • id (string): Example: seD4PfOuKoVMLkEZqohJ

    • dateAdded (string): Example: 2021-08-31T09:59:41.937Z

    • dateUpdated (string): Example: 2021-08-31T09:59:41.937Z

    • deleted (boolean): Example: False

    • tags (string[])

    • type (string): Example: read

    • customFields (object[])

      • id (string): Example: MgobCB14YMVKuE4Ka8p1

      • value (string): Example: name

    • locationId (string): Example: ve9EPM428h8vShlRW1KT

    • firstName (string): Example: rubika

    • firstNameLowerCase (string): Example: rubika

    • fullNameLowerCase (string): Example: rubika deo

    • lastName (string): Example: Deo

    • lastNameLowerCase (string): Example: deo

    • email (string): Example: rubika@deos.com

    • emailLowerCase (string): Example: rubika@deos.com

    • bounceEmail (boolean): Example: False

    • unsubscribeEmail (boolean): Example: False

    • dnd (boolean): Example: True

    • dndSettings (object)

      • Call (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

      • Email (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

      • SMS (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

      • WhatsApp (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

      • GMB (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

      • FB (object)

        • status (string, required): Possible values: 'active', 'inactive', 'permanent'

        • message (string)

        • code (string)

    • phone (string): Example: +18832327657

    • address1 (string): Example: 3535 1st St N

    • city (string): Example: ruDolomitebika

    • state (string): Example: AL

    • country (string): Example: US

    • postalCode (string): Example: 35061

    • website (string): Example: https://www.tesla.com

    • source (string): Example: public api

    • companyName (string): Example: DGS VolMAX

    • dateOfBirth (string): Example: Date format will be YYYY-MM-DDTHH:mm:ss.sssZ and Example 1990-09-25T00:00:00.000Z

    • birthMonth (number): Example: 8

    • birthDay (number): Example: 25

    • lastSessionActivityAt (string): Example: 2021-07-16T11:39:30.564Z

    • offers (string[])

    • products (string[])

    • businessId (string): Example: 641c094001436dbc2081e642

    • assignedTo (string): User's Id Example: y0BeYjuRIlDwsDcOHOJo

json
{
  "contact": {
    "id": "seD4PfOuKoVMLkEZqohJ",
    "dateAdded": "2021-08-31T09:59:41.937Z",
    "dateUpdated": "2021-08-31T09:59:41.937Z",
    "deleted": false,
    "tags": [
      "nisi sint commodo amet",
      "consequat"
    ],
    "type": "read",
    "customFields": [
      {
        "id": "MgobCB14YMVKuE4Ka8p1",
        "value": "name"
      }
    ],
    "locationId": "ve9EPM428h8vShlRW1KT",
    "firstName": "rubika",
    "firstNameLowerCase": "rubika",
    "fullNameLowerCase": "rubika deo",
    "lastName": "Deo",
    "lastNameLowerCase": "deo",
    "email": "rubika@deos.com",
    "emailLowerCase": "rubika@deos.com",
    "bounceEmail": false,
    "unsubscribeEmail": false,
    "dnd": true,
    "dndSettings": {
      "Call": {
        "status": "active",
        "message": "string",
        "code": "string"
      },
      "Email": {
        "status": "active",
        "message": "string",
        "code": "string"
      },
  // truncado: 40 lineas mas
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}
422 - Unprocessable Entity
json
{}

Example

curl -X POST 'https://services.leadconnectorhq.com/contacts/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "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": "string",
      "code": "string"
    },
    "Email": {
      "status": "active",
      "message": "string",
      "code": "string"
    },
    "SMS": {
      "status": "active",
      "message": "string",
      "code": "string"
    },
    "WhatsApp": {
      "status": "active",
      "message": "string",
      "code": "string"
    },
    "GMB": {
      "status": "active",
      "message": "string",
      "code": "string"
    },
    "FB": {
      "status": "active",
      "message": "string",
      "code": "string"
    }
  },
  "inboundDndSettings": {
    "all": {
      "status": "active",
      "message": "string"
    }
  },
  "tags": [
    "nisi sint commodo amet",
    "consequat"
  ],
  "customFields": [],
  "source": "public api",
  "dateOfBirth": "1990-09-25",
  "country": "US",
  "companyName": "DGS VolMAX",
  "assignedTo": "y0BeYjuRIlDwsDcOHOJo"
}'

Last updated October 26, 2026

Was this page helpful?