get
https://api.apollo.io/api/v1/duplicate_contacts/merge_jobs/
| Endpoint essentials | |
|---|---|
| API key access | api/v1/duplicate_contacts/merge_job or Master API key |
| OAuth scopes | contacts_deduplicate |
| Credit usage | 0 creditsLearn more about API pricing and credits. |
Contacts are people saved in Apollo.
Use the view a contact merge job endpoint to check the progress of a merge started with the merge duplicate contacts endpoint. Pass the deduplication_job_id from the merge response as the id path parameter.
A merge of 2 or more groups runs in the background. Call this endpoint until status is succeeded or failed. A merge of 1 group has already finished by the time the merge endpoint responds, so you don't need to check it.
Job status
status | Meaning |
|---|---|
queued | The merge is waiting to start. |
running | Apollo is merging the contacts. |
retrying | The merge hit a temporary error. Apollo retries it automatically, up to 15 times, and then marks it failed. retry_count shows the retries so far. |
succeeded | The merge finished. The duplicate contacts are deleted. |
failed | The merge stopped and won't be retried. Some groups may already be merged, and their duplicates deleted. The other contacts are released. To retry, send the groups again: a 422 CONTACTS_NOT_FOUND response lists in error_details.context.contact_ids the contacts already merged and deleted. Remove those and send the request again. |