About Bulk Jobs

The Contacts API allows you to perform these actions in bulk:

When your app calls one of the bulk endpoints listed above, a new bulk job is started, and the jobId is returned. You can use the Bulk Jobs API to get the status of any active or completed bulk job.

Was this helpful?
Yes
No

Bulk Job Object

Properties
idstringRead-onlyformat GUID

Bulk job ID.


typestring
6 enum supported values:
UNKNOWN_TYPEDELETEUPDATEADD_LABELSREMOVE_LABELSADD_REMOVE_LABELS

Bulk job type.


statusstring
6 enum supported values:
UNKNOWN_STATUSNEWLOADINGRUNNINGCOMPLETEDINDEXING

Status of the bulk job.


startedDatestringformat date-time

Date the bulk job started.


finishedDatestringformat date-time

Date the bulk job finished.


totalItemsinteger

Number of contacts that met the bulk job's filter criteria.


successTotalinteger

Number of contacts that were successfully processed.


failedTotalinteger

Number of contacts that couldn't be processed.


errorsArray <Error>

List of errors encountered.

Was this helpful?
Yes
No

GetList Bulk Jobs

Retrieves a list of bulk jobs. Up to 100 bulk jobs can be returned per request.

Bulk jobs are started with bulk operation endpoints in the Contacts API

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contacts
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/contacts/v4/bulk/jobs

Was this helpful?
Yes
No

GetGet Bulk Job

Retrieves a bulk job. Bulk jobs are started with bulk operation endpoints in the Contacts API

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contacts
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/contacts/v4/bulk/jobs/{id}

Was this helpful?
Yes
No