contacts
Get a bulk archive job
GET /v1/contacts/bulk-archive/{job_id}
Auth required
api.contacts.manage
Returns the state and counts of a job created by
POST /v1/contacts/bulk-archive. Poll until state is completed or
failed. Once completed, archived + already_archived + failed
equals matched. Jobs are kept for 24 hours.
Path parameters
job_id string<uuid> required Job ID returned by POST /v1/contacts/bulk-archive.
Responses
Errors follow the RFC 7807 problem format — see the error reference.
200 Job state and counts application/json
job_id string<uuid> required state string enum required One of: pending, running, completed, failed
matched integer required Contacts the selector named, including any already archived.
archived integer required Archived by this job.
already_archived integer required Archived before this job reached them.
failed integer required Could not be archived; the job carries on past them.
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 A query parameter, path value or body field failed validation.
The body is a
validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json 429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json