Skip to main content
DELETE
/
api
/
v1
/
contacts
/
{contact_id}
Cancel a queued contact (Enterprise)
curl --request DELETE \
  --url https://api.optimaldial.com/api/v1/contacts/{contact_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "cancelled",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credits_refunded": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.optimaldial.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OptimalDial API key, prefixed od_live_, sent as Authorization: Bearer .... Mint keys in the in-app developer panel; they are scoped to a single organization.

Path Parameters

​
contact_id
string<uuid>
required

Response

Cancelled.

​
status
enum<string>
required
Available options:
cancelled
​
contact_id
string<uuid>
required
​
credits_refunded
integer
required
Required range: x >= 0