Enqueue an asynchronous contact import
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"phone": "+14155550142",
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace"
},
{
"phone": "+14155550913",
"email": "grace@example.com",
"first_name": "Grace",
"last_name": "Hopper"
}
],
"file_name": "launch-signups.csv",
"merge_strategy": "merge"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/imports"
payload = {
"rows": [
{
"phone": "+14155550142",
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace"
},
{
"phone": "+14155550913",
"email": "grace@example.com",
"first_name": "Grace",
"last_name": "Hopper"
}
],
"file_name": "launch-signups.csv",
"merge_strategy": "merge"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
phone: '+14155550142',
email: 'ada@example.com',
first_name: 'Ada',
last_name: 'Lovelace'
},
{
phone: '+14155550913',
email: 'grace@example.com',
first_name: 'Grace',
last_name: 'Hopper'
}
],
file_name: 'launch-signups.csv',
merge_strategy: 'merge'
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/imports', 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.orbit.devotel.io/api/v1/contacts/imports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'phone' => '+14155550142',
'email' => 'ada@example.com',
'first_name' => 'Ada',
'last_name' => 'Lovelace'
],
[
'phone' => '+14155550913',
'email' => 'grace@example.com',
'first_name' => 'Grace',
'last_name' => 'Hopper'
]
],
'file_name' => 'launch-signups.csv',
'merge_strategy' => 'merge'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/contacts/imports"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.orbit.devotel.io/api/v1/contacts/imports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/imports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"job_id": "<string>",
"total_rows": 123,
"status": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Contacts
Enqueue an asynchronous contact import
Queue a large contact import for asynchronous processing instead of inserting rows synchronously. Accepts already field-mapped rows (up to 1,000,000) plus an optional file_name and merge_strategy (skip the existing contact, or merge to update it). Creates a pending import job and returns its job_id; poll GET /contacts/imports/{id} for progress. Retry POST after a few seconds when the queue is unavailable (503).
POST
/
api
/
v1
/
contacts
/
imports
Enqueue an asynchronous contact import
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts/imports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rows": [
{
"phone": "+14155550142",
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace"
},
{
"phone": "+14155550913",
"email": "grace@example.com",
"first_name": "Grace",
"last_name": "Hopper"
}
],
"file_name": "launch-signups.csv",
"merge_strategy": "merge"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts/imports"
payload = {
"rows": [
{
"phone": "+14155550142",
"email": "ada@example.com",
"first_name": "Ada",
"last_name": "Lovelace"
},
{
"phone": "+14155550913",
"email": "grace@example.com",
"first_name": "Grace",
"last_name": "Hopper"
}
],
"file_name": "launch-signups.csv",
"merge_strategy": "merge"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rows: [
{
phone: '+14155550142',
email: 'ada@example.com',
first_name: 'Ada',
last_name: 'Lovelace'
},
{
phone: '+14155550913',
email: 'grace@example.com',
first_name: 'Grace',
last_name: 'Hopper'
}
],
file_name: 'launch-signups.csv',
merge_strategy: 'merge'
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts/imports', 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.orbit.devotel.io/api/v1/contacts/imports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rows' => [
[
'phone' => '+14155550142',
'email' => 'ada@example.com',
'first_name' => 'Ada',
'last_name' => 'Lovelace'
],
[
'phone' => '+14155550913',
'email' => 'grace@example.com',
'first_name' => 'Grace',
'last_name' => 'Hopper'
]
],
'file_name' => 'launch-signups.csv',
'merge_strategy' => 'merge'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.orbit.devotel.io/api/v1/contacts/imports"
payload := strings.NewReader("{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.orbit.devotel.io/api/v1/contacts/imports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts/imports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rows\": [\n {\n \"phone\": \"+14155550142\",\n \"email\": \"ada@example.com\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\"\n },\n {\n \"phone\": \"+14155550913\",\n \"email\": \"grace@example.com\",\n \"first_name\": \"Grace\",\n \"last_name\": \"Hopper\"\n }\n ],\n \"file_name\": \"launch-signups.csv\",\n \"merge_strategy\": \"merge\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"job_id": "<string>",
"total_rows": 123,
"status": "<string>"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
Required string length:
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
Available options:
true, false Body
application/json
Already field-mapped rows keyed by contact field (phone, email, first_name, …).
Required array length:
1 - 1000000 elementsShow child attributes
Show child attributes
Original upload filename shown in the imports history.
Required string length:
1 - 255How to treat a row whose phone/email matches an existing contact: skip (default) leaves the existing contact untouched; merge updates it.
Available options:
skip, merge Response
Import queued. Poll GET /contacts/imports/{job_id} for progress — /imports/{job_id} single-segment GET, not /import-jobs/{id} (that route carries only the skipped-rows CSV).