Matchai Docs

Delete a contactComing soon

Deletes the contact record and its pipeline details. Conversations with the person are not deleted.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
DELETE
/contacts/{contact_id}

Coming soon. Deletes the contact record and its pipeline details. Conversations with the person are not deleted.

Final action. When the connection is set to Ask me, this call returns 202 with an approval_url and does nothing until the account holder approves it in Matchai; Matchai then performs it exactly as sent and sends approval.resolved. When the connection is set to Allowed, it runs straight away.

Scopes: contacts:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: contacts:write

Path Parameters

contact_id*string

Contact id.

Length1 <= length <= 64

Response Body

The connection is set to Ask me: the action waits for the account holder’s approval and nothing has happened yet.

application/json
  1. response

Returned with 202 Accepted when a final action needs the account holder to approve it first. Nothing has happened yet. Matchai performs the call exactly as sent once it is approved, and sends the approval.resolved webhook.

status*string
approval_id*string

The approval to poll with GET /approvals/{approval_id}.

Length1 <= length <= 64
approval_url*string

Where the account holder approves or declines the action in Matchai. You can show or open this link.

Formaturi
expires_at*string

When the request lapses if nobody answers it.

Formatdate-time
summary*string

A plain-words description of the action, as the account holder sees it.

Example Request
curl -X DELETE 'https://api.matchai.co/v1/contacts/string'
Example Response
{  "status": "pending_approval",  "approval_id": "string",  "approval_url": "http://example.com",  "expires_at": "2019-08-24T14:15:22Z",  "summary": "string"}