Setting the file. One moment.
Subchapter 8.30
references/contacts/bulk-label-and-unlabel-contacts.mdMarkdown3 KBView on GitHub
Adds and removes labels from multiple contacts using the Wix Contacts REST API.
Labels are added to and removed from all contacts that meet the specified filter and search criteria.
The request should specify a filter value, a search value, or both.
To perform a dry run, call with the intended filter options.
When this method is used, a bulk job is started and the job ID is returned. The job might not complete right away, depending on its size. The job’s status can be retrieved with Get Bulk Job (opens in a new tab).
IMPORTANT NOTE: When specific contacts are to be labeled, they should be filtered by id.
POST https://www.wixapis.com/contacts/v4/bulk/contacts/add-remove-labels
curl -X POST \
'https://www.wixapis.com/contacts/v4/bulk/contacts/add-remove-labels' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
-d '{
"filter": {
"info.name.first": "John"
},
"labelKeysToAdd": ["custom.name-john", "custom.name-starts-with-J"],
"labelKeysToRemove": ["custom.last-name-smith"]
}'filter (object, optional): Filter criteria to identify contacts. When specific contacts are to be labeled, filter by id.search (string, optional): Search query to identify contacts.labelKeysToAdd (array of strings): Array of label keys to add to matching contacts.labelKeysToRemove (array of strings): Array of label keys to remove from matching contacts.Note: The request should specify a filter value, a search value, or both.
The response includes a jobId which can be used to track the bulk job status:
{
"jobId": "00000000-0000-0000-0000-000000000001"
}Use the Get Bulk Job (opens in a new tab) endpoint to check the job status.
CONTACTS.MODIFY