Upsert Contact

Please find the list of acceptable values for the country field here<br/><br/>The Upsert API will adhere to the configuration defined under the “Allow Duplicate Contact” setting at the Account level. If the setting is configured to check both Email and Phone, the API will attempt to identify an existing contact based on the priority sequence specified in the setting, and will create or update the contact accordingly.<br/><br/>If two separate contacts already exist—one with the same email and another with the same phone—and an upsert request includes both the email and phone, the API will update the contact that matches the first field in the configured sequence, and ignore the second field to prevent duplication.

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

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

string

default:"Rosan"

string

default:"Deo"

string

default:"Rosan Deo"

string

default:"rosan@deos.com"

string

default:"ve9EPM428h8vShlRW1KT"

required

string

default:"male"

string

default:"+1 888-888-8888"

string

default:"3535 1st St N"

string

default:"Dolomite"

string

default:"AL"

string

default:"35061"

string

default:"https://www.tesla.com"

string

default:"America/Chihuahua"

boolean

default:"True"

object

Show propiedades

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’

string

string[]

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.

object[]

string

default:"public api"

object

default:"1990-09-25"

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

string

default:"US"

string

default:"DGS VolMAX"

string

default:"y0BeYjuRIlDwsDcOHOJo"

User’s Id

boolean

default:"False"

Controls whether to create a new contact or update an existing duplicate. Scenario 1: If this value is true and the account allows duplicate contacts, a new contact will be created immediately without checking for duplicates. Scenario 2: If this value is true but the account 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 account’s duplicate contact setting.

Respuestas

200 - Successful response

boolean

default:"True"

object

Show propiedades

string

default:"seD4PfOuKoVMLkEZqohJ"

string

default:"rubika deo"

string

default:"ve9EPM428h8vShlRW1KT"

string

default:"rubika"

string

default:"Deo"

string

default:"rubika@deos.com"

string

default:"rubika@deos.com"

string

default:"Asia/Calcutta"

string

default:"DGS VolMAX"

string

default:"+18832327657"

boolean

default:"True"

object

Show propiedades

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

object

Show propiedades

string

required

Posibles valores: ‘active’, ‘inactive’, ‘permanent’

string

default:"read"

string

default:"public api"

string

default:"ve9EPM428h8vShlRW1KT"

string

default:"3535 1st St N"

string

default:"ruDolomitebika"

string

default:"AL"

string

default:"US"

string

default:"35061"

string

default:"https://www.tesla.com"

string[]

string

default:"Date format YYYY-MM-DD"

string

default:"2021-07-02T05:18:26.704Z"

string

default:"2021-07-02T05:18:26.704Z"

string

default:"test"

string

default:"rubika"

string

default:"rubika deo"

string

default:"deo"

string

default:"2021-07-16T11:39:30.564Z"

object[]

Show cada item

string

default:"MgobCB14YMVKuE4Ka8p1"

string

default:"name"

string

default:"641c094001436dbc2081e642"

object

Show propiedades

string

default:"Trigger Link"

required

string

default:"https: //www.google.com"

string

default:"fb. 1.1674748390986.1171287961"

string

default:"Mozilla/5.0"

string

default:"Mozilla/5.0"

string

default:"58.111.106.198"

string

default:"survey"

string

default:"FglfHAn30PRwsZVyQlKp"

object

Show propiedades

string

default:"Trigger Link"

required

string

default:"https: //www.google.com"

string

default:"fb. 1.1674748390986.1171287961"

string

default:"Mozilla/5.0"

string

default:"Mozilla/5.0"

string

default:"58.111.106.198"

string

default:"survey"

string

default:"FglfHAn30PRwsZVyQlKp"

string

default:"ve9EPM428h8vShlRW1KT"

visitorId is the Unique ID assigned to each Live chat visitor.

string

{
  "new": true,
  "contact": {
    "id": "seD4PfOuKoVMLkEZqohJ",
    "name": "rubika deo",
    "locationId": "ve9EPM428h8vShlRW1KT",
    "firstName": "rubika",
    "lastName": "Deo",
    "email": "rubika@deos.com",
    "emailLowerCase": "rubika@deos.com",
    "timezone": "Asia/Calcutta",
    "companyName": "DGS VolMAX",
    "phone": "+18832327657",
    "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"
  // truncado: 81 lineas mas
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/contacts/upsert' \
  -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",
  "createNewIfDuplicateAllowed": false
}'

const response = await fetch('https://services.leadconnectorhq.com/contacts/upsert', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    '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": "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", "createNewIfDuplicateAllowed": false}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/contacts/upsert',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"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", "createNewIfDuplicateAllowed": false},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/contacts/upsert');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'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', 'createNewIfDuplicateAllowed': false}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo