bulkLabelAndUnlabelContacts( )


Adds and removes labels from multiple contacts.

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 Query Contacts 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.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkLabelAndUnlabelContactsOptions

Bulk label and unlabel contacts options.

Returns
Return Type:Promise<BulkLabelAndUnlabelContactsResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?