Import Contacts

Import a list of contacts

put/companies/{company}/contacts

Path parameters

companyinteger required

Request body

Response

Contacts will be imported asynchronously. This response contains batch information that can be used to check the progress.

Progress can be tracked by polling the progress endpoint, or via webhooks. You can listen to the contact-import-batch-progress-updated event on the companies@{company} channel. The event payload will be a ContactImportBatch.

idstring uuid

namestring

totalJobsinteger

pendingJobsinteger

failedJobsinteger

progressinteger

createdAtstring

cancelledAtstring

finishedAtstring

Example response

{
  "createdAt": "2023-01-01 01:01:01",
  "cancelledAt": "2023-01-01 01:01:01",
  "finishedAt": "2023-01-01 01:01:01"
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.