Skip to main content
POST
Erase a contact

Authorizations

Authorization
string
header
required

An API key (utk_live_...) or an app's OAuth access token (uto_...).

Headers

Idempotency-Key
string

Any 1 to 255 printable ASCII characters, without a space at either end. The answer to the first request with a key is kept for 24 hours per credential: the same request again gets it back (Idempotent-Replayed: true), another request with the key is 409 PUB-002-002, and while the first still runs 409 PUB-002-003. A server error is not kept, and a request that never answered frees its key after 2 minutes: a retry with the key then runs again.

Maximum string length: 255

Path Parameters

contactId
string<uuid>
required

A contact id.

Response

The job.

id
string<uuid>
required
type
enum<string>
required
Available options:
responses.erase,
responses.delete,
contacts.erase
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
subject
string | null
required

The response id, the respondent's email masked, or the contact's id (contacts.erase).

result
object
required
error
string | null
required

An error code when it failed.

url
string<uri>
required
createdAt
string<date-time>
required
Example:

"2026-09-30T10:00:00.000Z"

startedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

finishedAt
string<date-time> | null
required
Example:

"2026-09-30T10:00:00.000Z"

Last modified on November 8, 2026