Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt

Use this file to discover all available pages before exploring further.

Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts
POST https://services.leadconnectorhq.com/contacts/bulk/tags/update/{type}

Autorizacion

Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticacion.
Version
string
default:"2021-07-28"
required
Version de la API.

Body

contacts
string[]
required
list of contact ids to be processed
tags
string[]
required
list of tags to be added or removed
locationId
string
default:"asdrwHvLUxlfw5SqKVCN"
required
account id from where the bulk request is executed
removeAllTags
boolean
default:"false"
Option to implement remove all tags. if true, all tags will be removed from the contacts. Can only be used with remove type.

Respuestas

succeded
boolean
default:"True"
required
Indicates if the operation was successful
errorCount
number
default:"0"
required
Number of errors encountered during the operation
responses
string[]
required
Responses for each contact processed
{
  "succeded": true,
  "errorCount": 0,
  "responses": [
    {
      "contactId": "qFSqySFkVvNzOSqgGqFi",
      "message": "Tags updated",
      "type": "success",
      "oldTags": [
        "tag-1",
        "tag-2"
      ],
      "tagsAdded": [],
      "tagsRemoved": []
    },
    {
      "contactId": "abcdef",
      "message": "contact id is not a valid firebase id",
      "type": "error"
    },
    {
      "contactId": "qFSqySFkVvNzOSqgGqFi",
      "message": "contact is deleted",
      "type": "error"
    },
    {
      "contactId": "3ualbhnV7j3n3a9r2moD",
      "message": "contact does not belong to account",
      "type": "error"
    }
  ]
}
{}
{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/contacts/bulk/tags/update/YOUR_type' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "contacts": [
    "qFSqySFkVvNzOSqgGqFi",
    "abcdef",
    "qFSqySFkVvNzOSqgGqFi",
    "3ualbhnV7j3n3a9r2moD"
  ],
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "locationId": "asdrwHvLUxlfw5SqKVCN",
  "removeAllTags": "false"
}'