Skip to main content
POST
/
api
/
v1
/
contacts
Create a contact (Enterprise)
curl --request POST \
  --url https://api.optimaldial.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "+15551234567",
  "properties": {},
  "callback_url": "<string>",
  "callback_secret": "<string>",
  "idempotency_key": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone": "+15551234567",
  "properties": {},
  "status": "queued",
  "credits_charged": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "optimaldial_status": "<string>",
  "error_message": "<string>"
}

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.

Body

application/json
​
phone
string
required

Any common format. Normalized to E.164. Must be US or Canadian.

Example:

"+15551234567"

​
properties
object

Arbitrary extra fields echoed back in the result payload. Use these to correlate the result with your own row IDs.

​
callback_url
string<uri>

Optional per-contact webhook URL. Receives a signed POST when the contact's result is ready, with the same retry semantics as registered org-level webhook endpoints (6 attempts with backoff).

​
callback_secret
string

HMAC-SHA256 secret used to sign the callback_url payload.

​
idempotency_key
string

Optional. Re-posting with the same key returns the existing contact without an extra credit charge. Scoped per (organization, api_key).

Maximum string length: 255

Response

Contact created (or returned via idempotency).

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
phone
string
required

E.164-normalized phone number (US/CA only).

Example:

"+15551234567"

​
properties
object
required

Arbitrary extra fields echoed back from creation.

​
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed,
discarded
​
credits_charged
integer
required
Required range: x >= 0
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
optimaldial_status
string | null

The classification — e.g. "Likely Answer", "Likely Voicemail". Populated when status == "completed".

​
error_message
string | null