Create an upload

curl --request POST \
  --url https://api.optimaldial.com/api/v1/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'phone_column=<string>' \
  --form skip_mobile_lookup=false \
  --form validation_tier=standard \
  --form 'filename_override=<string>' \
  --form 'full_name_column=<string>' \
  --form 'first_name_column=<string>' \
  --form 'last_name_column=<string>'

import requests

url = "https://api.optimaldial.com/api/v1/uploads"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "phone_column": "<string>",
    "skip_mobile_lookup": "false",
    "validation_tier": "standard",
    "filename_override": "<string>",
    "full_name_column": "<string>",
    "first_name_column": "<string>",
    "last_name_column": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('phone_column', '<string>');
form.append('skip_mobile_lookup', 'false');
form.append('validation_tier', 'standard');
form.append('filename_override', '<string>');
form.append('full_name_column', '<string>');
form.append('first_name_column', '<string>');
form.append('last_name_column', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.optimaldial.com/api/v1/uploads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.optimaldial.com/api/v1/uploads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.optimaldial.com/api/v1/uploads"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.optimaldial.com/api/v1/uploads")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.optimaldial.com/api/v1/uploads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "original_filename": "<string>",
  "status": "pending_mapping",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_size_bytes": 123,
  "valid_row_count": 123,
  "invalid_row_count": 123,
  "credits_required": 123,
  "credits_charged": 123,
  "credits_refunded": 123,
  "source": "web",
  "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skip_mobile_lookup": true,
  "validation_tier": "standard",
  "identity_enabled": true,
  "result_summary": {
    "format": "identity",
    "total_rows": 123,
    "status_counts": {
      "1 - Likely Right-Party Answer": 303,
      "5 - Likely Right-Party Voicemail": 891,
      "8 - Likely Wrong Number": 463
    },
    "identity_counts": {
      "Very High": 344,
      "High": 846,
      "Low": 463
    },
    "has_answer_intent_column": true,
    "has_identity_column": true
  },
  "export_count": 123,
  "last_exported_at": "2023-11-07T05:31:56Z",
  "processed_available": true,
  "processed_filtered_available": true,
  "error_message": "<string>",
  "exceeded_daily_limit": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "error": "min_contacts_required",
    "min": 123,
    "got": 123,
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "rate_limit_exceeded",
    "scope": "per_key",
    "limit": 123,
    "retry_after_seconds": 123
  }
}

POST

api

uploads

Create an upload

curl --request POST \
  --url https://api.optimaldial.com/api/v1/uploads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'phone_column=<string>' \
  --form skip_mobile_lookup=false \
  --form validation_tier=standard \
  --form 'filename_override=<string>' \
  --form 'full_name_column=<string>' \
  --form 'first_name_column=<string>' \
  --form 'last_name_column=<string>'

import requests

url = "https://api.optimaldial.com/api/v1/uploads"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "phone_column": "<string>",
    "skip_mobile_lookup": "false",
    "validation_tier": "standard",
    "filename_override": "<string>",
    "full_name_column": "<string>",
    "first_name_column": "<string>",
    "last_name_column": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('phone_column', '<string>');
form.append('skip_mobile_lookup', 'false');
form.append('validation_tier', 'standard');
form.append('filename_override', '<string>');
form.append('full_name_column', '<string>');
form.append('first_name_column', '<string>');
form.append('last_name_column', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.optimaldial.com/api/v1/uploads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.optimaldial.com/api/v1/uploads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.optimaldial.com/api/v1/uploads"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.optimaldial.com/api/v1/uploads")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.optimaldial.com/api/v1/uploads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"phone_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"skip_mobile_lookup\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"validation_tier\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filename_override\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"full_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"first_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"last_name_column\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "original_filename": "<string>",
  "status": "pending_mapping",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "file_size_bytes": 123,
  "valid_row_count": 123,
  "invalid_row_count": 123,
  "credits_required": 123,
  "credits_charged": 123,
  "credits_refunded": 123,
  "source": "web",
  "api_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skip_mobile_lookup": true,
  "validation_tier": "standard",
  "identity_enabled": true,
  "result_summary": {
    "format": "identity",
    "total_rows": 123,
    "status_counts": {
      "1 - Likely Right-Party Answer": 303,
      "5 - Likely Right-Party Voicemail": 891,
      "8 - Likely Wrong Number": 463
    },
    "identity_counts": {
      "Very High": 344,
      "High": 846,
      "Low": 463
    },
    "has_answer_intent_column": true,
    "has_identity_column": true
  },
  "export_count": 123,
  "last_exported_at": "2023-11-07T05:31:56Z",
  "processed_available": true,
  "processed_filtered_available": true,
  "error_message": "<string>",
  "exceeded_daily_limit": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": {
    "error": "min_contacts_required",
    "min": 123,
    "got": 123,
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "rate_limit_exceeded",
    "scope": "per_key",
    "limit": 123,
    "retry_after_seconds": 123
  }
}

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

file

required

CSV file (≤100 MB, must include a header row).

phone_column

string

required

Name of the column containing phone numbers.

skip_mobile_lookup

boolean

default:false

validation_tier

enum<string>

default:standard

Validation tier. standard charges 1 credit/contact; max is more thorough and charges 1.5 credits/contact (billed as ceil(valid_count × 1.5)).

Available options:

standard,

max

filename_override

string

Override the file's original name.

full_name_column

string

Enables OptimalDial Identity. Name of the column holding the contact's full name. Supply this OR both first_name_column and last_name_column.

first_name_column

string

Enables OptimalDial Identity when supplied together with last_name_column. Supplying only one half returns 400.

last_name_column

string

Enables OptimalDial Identity when supplied together with first_name_column. Supplying only one half returns 400.

Response

Upload created, credits charged, ready for processing.

string<uuid>

required

user_id

string<uuid>

required

original_filename

string

required

status

enum<string>

required

cancelled is a legacy value retained so historical uploads still parse — no new upload can enter it.

Available options:

pending_mapping,

validating,

validation_failed,

awaiting_confirmation,

ready_for_processing,

processing,

completed,

failed,

cancelled

created_at

string<date-time>

required

updated_at

string<date-time>

required

organization_id

string<uuid> | null

file_size_bytes

integer | null

valid_row_count

integer | null

invalid_row_count

integer | null

credits_required

integer | null

credits_charged

integer | null

credits_refunded

integer | null

Credits returned to the organization when OptimalDial refunds an upload.

source

enum<string> | null

web for in-app uploads, api for direct /api/v1/uploads calls, api_pool for uploads synthesized from the Contacts API.

Available options:

web,

api,

api_pool,

null

api_key_id

string<uuid> | null

skip_mobile_lookup

boolean | null

validation_tier

enum<string> | null

Validation tier used for this upload (standard or max).

Available options:

standard,

max,

null

identity_enabled

boolean | null

Whether OptimalDial Identity was requested for this upload, i.e. a name column was mapped at creation.

result_summary

object | null

Distribution of the results, populated once status == "completed". Lets you see the shape of a list without downloading it.

Show child attributes

export_count

integer

How many times these results have been downloaded, counting both the web app and this API.

last_exported_at

string<date-time> | null

processed_available

boolean

true once the processed file can be downloaded. Storage keys are deliberately not exposed — use the download endpoints.

processed_filtered_available

boolean

true once the deprecated download/processed-filtered endpoint will succeed, whether from a stored file or generated on demand.

error_message

string | null

exceeded_daily_limit

boolean | null

Get started

Endpoint guides

Webhooks

API Reference

Resources

Create an upload

Authorizations

Body

Response