{"id":"ef9e7779-2759-44af-9225-cf186a3fcf28","createdDate":"2023-07-30T12:42:17.446Z","updatedDate":"2023-07-30T12:42:17.446Z","resourceId":"781ce802-7751-44ea-b3b6-47476bc690bc","api":{"schema":{"object":{"displayName":"Bulk Job Object","description":"","slug":"bulk-job-object","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/crm.git"},"methods":[{"summary":"List Bulk Jobs","description":"Retrieves a list of bulk jobs.\nUp to 100 bulk jobs can be returned per request.\n\nBulk jobs are started with bulk operation endpoints in the\n[Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object)","operationId":"com.wixpress.contacts.core.api.v4.ContactsBulkService.ListBulkJobs","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ListBulkJobsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wix.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.wix.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"manage._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wixapis.com/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www.wixapis.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.wix.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"manage._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wix.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.nownia.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"manage.nownia.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.nownia.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"manage.nownia.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListBulkJobsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListBulkJobsResponse"},"legacyExamples":[{"name":"ListBulkJobs","serviceName":"ContactsBulkService","type":"METHOD","content":{"title":"List Jobs","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs' \\\n -H 'Authorization: '","response":"{\n \"jobs\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"DELETE\",\n \"status\": \"COMPLETED\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"finishedDate\": \"2019-10-30T17:25:10.299Z\",\n \"totalItems\": 45,\n \"processedCount\": 42,\n \"failedCount\": 3,\n \"errors\": [\n {\n \"errorCode\": 3001,\n \"message\": \"Could not delete Site Member(s)\"\n }\n ]\n },\n {\n \"id\": \"3214df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"ADD_LABELS\",\n \"status\": \"RUNNING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 100,\n \"failedCount\": 0,\n \"errors\": []\n },\n {\n \"id\": \"3214df3c-1221-4098-a5ab-c91ad8f33c47\",\n \"type\": \"REMOVE_LABELS\",\n \"status\": \"LOADING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\": []\n },\n {\n \"id\": \"3214df3c-1221-4545-a5ab-c91ad8f33c47\",\n \"type\": \"UPDATE\",\n \"status\": \"NEW\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 0,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\": []\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/bulk/jobs","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListBulkJobsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListBulkJobsResponse"},"legacyExamples":[{"name":"ListBulkJobs","serviceName":"ContactsBulkService","type":"METHOD","content":{"title":"List Jobs","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs' \\\n -H 'Authorization: '","response":"{\n \"jobs\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"DELETE\",\n \"status\": \"COMPLETED\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"finishedDate\": \"2019-10-30T17:25:10.299Z\",\n \"totalItems\": 45,\n \"processedCount\": 42,\n \"failedCount\": 3,\n \"errors\": [\n {\n \"errorCode\": 3001,\n \"message\": \"Could not delete Site Member(s)\"\n }\n ]\n },\n {\n \"id\": \"3214df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"ADD_LABELS\",\n \"status\": \"RUNNING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 100,\n \"failedCount\": 0,\n \"errors\": []\n },\n {\n \"id\": \"3214df3c-1221-4098-a5ab-c91ad8f33c47\",\n \"type\": \"REMOVE_LABELS\",\n \"status\": \"LOADING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\": []\n },\n {\n \"id\": \"3214df3c-1221-4545-a5ab-c91ad8f33c47\",\n \"type\": \"UPDATE\",\n \"status\": \"NEW\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 0,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\": []\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"List Bulk Jobs","slugifiedName":"list-bulk-jobs"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Get Bulk Job","description":"Retrieves a bulk job.\nBulk jobs are started with bulk operation endpoints in the\n[Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object)","operationId":"com.wixpress.contacts.core.api.v4.ContactsBulkService.GetBulkJob","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"Bulk job ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.GetBulkJobResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wix.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.wix.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"manage._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wixapis.com/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www.wixapis.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.wix.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"manage._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://www.wix.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www._base_domain_","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.nownia.com/_api/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"manage.nownia.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}},{"url":"https://manage.nownia.com/_api/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"manage.nownia.com","serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.GetBulkJobRequest","responseMessage":"com.wixpress.contacts.core.api.v4.GetBulkJobResponse"},"legacyExamples":[{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":3,"content":{"title":"Get Bulk Job (Loading)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-1221-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-1221-4098-a5ab-c91ad8f33c47\",\n \"type\": \"REMOVE_LABELS\",\n \"status\": \"LOADING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":4,"content":{"title":"Get Bulk Job (New Job, Not Started)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-1221-4545-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-1221-4545-a5ab-c91ad8f33c47\",\n \"type\": \"UPDATE\",\n \"status\": \"NEW\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 0,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":1,"content":{"title":"Get Bulk Job (Finished with Errors)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"DELETE\",\n \"status\": \"COMPLETED\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"finishedDate\": \"2019-10-30T17:25:10.299Z\",\n \"totalItems\": 45,\n \"processedCount\": 42,\n \"failedCount\": 3,\n \"errors\" : [\n {\n \"errorCode\": 3001,\n \"message\": \"Could not delete Site Member(s)\"\n }\n ]\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":2,"content":{"title":"Get Bulk Job (In Progress)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"ADD_LABELS\",\n \"status\": \"RUNNING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 100,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/bulk/jobs/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsBulkService","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.GetBulkJobRequest","responseMessage":"com.wixpress.contacts.core.api.v4.GetBulkJobResponse"},"legacyExamples":[{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":3,"content":{"title":"Get Bulk Job (Loading)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-1221-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-1221-4098-a5ab-c91ad8f33c47\",\n \"type\": \"REMOVE_LABELS\",\n \"status\": \"LOADING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":4,"content":{"title":"Get Bulk Job (New Job, Not Started)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-1221-4545-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-1221-4545-a5ab-c91ad8f33c47\",\n \"type\": \"UPDATE\",\n \"status\": \"NEW\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 0,\n \"processedCount\": 0,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":1,"content":{"title":"Get Bulk Job (Finished with Errors)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"DELETE\",\n \"status\": \"COMPLETED\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"finishedDate\": \"2019-10-30T17:25:10.299Z\",\n \"totalItems\": 45,\n \"processedCount\": 42,\n \"failedCount\": 3,\n \"errors\" : [\n {\n \"errorCode\": 3001,\n \"message\": \"Could not delete Site Member(s)\"\n }\n ]\n }\n}"}},{"name":"GetBulkJob","serviceName":"ContactsBulkService","type":"METHOD","order":2,"content":{"title":"Get Bulk Job (In Progress)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/bulk/contact/jobs/3214df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"job\": {\n \"id\": \"3214df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"type\": \"ADD_LABELS\",\n \"status\": \"RUNNING\",\n \"startedDate\": \"2019-10-30T17:22:10.299Z\",\n \"totalItems\": 300,\n \"processedCount\": 100,\n \"failedCount\": 0,\n \"errors\" : []\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Get Bulk Job","slugifiedName":"get-bulk-job"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true}],"webhooks":[],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Bulk Jobs\n\nThe Contacts API allows you to perform these actions in bulk:\n\n- [Bulk Label and Unlabel Contacts][bulk-label-unlabel]\n- [Bulk Update Contacts][bulk-update]\n- [Bulk Delete Contacts][bulk-delete]\n\nWhen your app calls one of the bulk endpoints listed above,\na new bulk job is started, and the `jobId` is returned.\nYou can use the Bulk Jobs API\nto get the status of any active or completed bulk job.\n\n[bulk-label-unlabel]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-label-and-unlabel-contacts\n[bulk-update]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-update-contacts\n[bulk-delete]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-delete-contacts","sourceRepo":"git@github.com:wix-private/crm.git","path":"docs/bulk-jobs.md"}],"components":{"schemas":{"com.wixpress.contacts.core.api.v4.ContactBulkJob":{"type":"object","properties":{"id":{"title":"id","description":"Bulk job ID.","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"type":{"title":"type","description":"Bulk job type.","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob.JobType","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Status of the bulk job.","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob.JobStatus","x-wix-docs":{"exposure":"PUBLIC"}},"startedDate":{"title":"startedDate","description":"Date the bulk job started.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"finishedDate":{"title":"finishedDate","description":"Date the bulk job finished.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"totalItems":{"title":"totalItems","description":"Number of contacts that met the bulk job's filter criteria.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"successTotal":{"title":"successTotal","description":"Number of contacts that were successfully processed.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"failedTotal":{"title":"failedTotal","description":"Number of contacts that couldn't be processed.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"errors":{"title":"errors","description":"List of errors encountered.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob.Error"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ContactBulkJob","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.contacts.core.api.v4.ContactBulkJob.JobType":{"type":"string","description":"","title":"JobType","enum":["UNKNOWN_TYPE","DELETE","UPDATE","ADD_LABELS","REMOVE_LABELS","ADD_REMOVE_LABELS"]},"com.wixpress.contacts.core.api.v4.ContactBulkJob.JobStatus":{"type":"string","description":"","title":"JobStatus","enum":["UNKNOWN_STATUS","NEW","LOADING","RUNNING","COMPLETED","INDEXING"]},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.contacts.core.api.v4.ContactBulkJob.Error":{"type":"object","properties":{"count":{"title":"count","description":"Number of contacts with this error.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"code":{"title":"code","description":"Error code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"message":{"title":"message","description":"Error details.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Error","description":""},"com.wixpress.contacts.core.api.v4.ListBulkJobsRequest":{"type":"object","properties":{},"title":"ListBulkJobsRequest","description":""},"com.wixpress.contacts.core.api.v4.ListBulkJobsResponse":{"type":"object","properties":{"jobs":{"title":"jobs","description":"List of bulk jobs.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListBulkJobsResponse","description":""},"com.wixpress.contacts.core.api.v4.GetBulkJobRequest":{"type":"object","properties":{"id":{"title":"id","description":"Bulk job ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetBulkJobRequest","description":""},"com.wixpress.contacts.core.api.v4.GetBulkJobResponse":{"type":"object","properties":{"job":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactBulkJob","summary":"job","description":"Bulk job details.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetBulkJobResponse","description":""}}},"title":"Bulk Job","description":"","fqdn":"wix.contacts.v4.bulk_job"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Bulk Jobs\n\nThe Contacts API allows you to perform these actions in bulk:\n\n- [Bulk Label and Unlabel Contacts][bulk-label-unlabel]\n- [Bulk Update Contacts][bulk-update]\n- [Bulk Delete Contacts][bulk-delete]\n\nWhen your app calls one of the bulk endpoints listed above,\na new bulk job is started, and the `jobId` is returned.\nYou can use the Bulk Jobs API\nto get the status of any active or completed bulk job.\n\n[bulk-label-unlabel]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-label-and-unlabel-contacts\n[bulk-update]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-update-contacts\n[bulk-delete]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/bulk-delete-contacts"}]},"reviewStatus":"APPROVED","isLocked":true}