Contacts

Cancel a contact import

Stop a pending or processing import job. A running import stops at its next chunk of rows; contacts it already imported are kept. The job's status becomes canceled. A job that has already finished returns 409. Check its progress first with Retrieve a contact import. Requires the contacts:write capability.

post/contacts/imports/{id}/cancel

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/contacts/imports/{id}/cancel
  • Auth: HTTP bearer

Response

The canceled import job.

object'contact_import' required
idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'canceled' required
totalnumber required
importednumber required
skippednumber required
failednumber required
errorstring nullable required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.