Bulk API and webhooks Plus
Move a lot of data in, and hear about every change
Import 100,000 contacts or export every record in one request, as jobs that run on their own. Send signed notices to your own server the moment a record is made, changed or deleted, records of your own types and calls included.
Bulk jobs
- Import up to 100,000 contacts as JSON or a CSV file, with your custom fields as columns, skipping or filling in contacts that are already here. The same rules as an import from the Contacts page: one email, one contact.
- Export every contact, company, deal or case, or every record of one of your own types.
- Follow the job by its id: how far it has got, the rows it refused and why, and the results, a page at a time.
- Versions on every record, so a change made from a copy that is out of date is refused rather than written over a colleague’s.
Webhooks
Choose the events an endpoint hears: contacts, companies, deals and cases made or changed, a case replied to, a call ended or recorded, a voicemail left, contacts merged, a member’s role changed, and a record of your own type made, changed or deleted.
Each delivery is signed with a secret shown once, carries the record’s id and the fields that changed (never a reply’s words or a caller’s number), and is tried again for about a day if your server does not answer.
Questions
How many records can one bulk import take?
Up to 100,000 contacts in one request, as JSON or a CSV file. It runs as a job on its own; you ask for its progress, its errors and its results by its id.
What stops two systems overwriting each other’s changes?
Every record read through the API carries its version. Send the version back with a change, and ContactRoll refuses the change if somebody changed the record since you read it.
Which plan has the API?
Plus has the API, bulk jobs and webhooks, at up to 600 requests a minute. Standard has the narrower Connect your app key, at up to 120 a minute, for keeping contacts and companies in step with your own app.