Create a contact
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"attributes": {}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts"
payload = {
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": ["<string>"],
"attributes": {}
}
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({
phone: '<string>',
email: '<string>',
first_name: '<string>',
last_name: '<string>',
display_name: '<string>',
company: '<string>',
country_code: '<string>',
timezone: '<string>',
language: '<string>',
tags: ['<string>'],
attributes: {}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts', 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",
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([
'phone' => '<string>',
'email' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'display_name' => '<string>',
'company' => '<string>',
'country_code' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'tags' => [
'<string>'
],
'attributes' => [
]
]),
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"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts")
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 \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"attributes": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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>"
}
}Contacts
Create a contact
Create a new contact. At least one of phone or email is required.
POST
/
api
/
v1
/
contacts
Create a contact
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"attributes": {}
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/contacts"
payload = {
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": ["<string>"],
"attributes": {}
}
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({
phone: '<string>',
email: '<string>',
first_name: '<string>',
last_name: '<string>',
display_name: '<string>',
company: '<string>',
country_code: '<string>',
timezone: '<string>',
language: '<string>',
tags: ['<string>'],
attributes: {}
})
};
fetch('https://api.orbit.devotel.io/api/v1/contacts', 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",
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([
'phone' => '<string>',
'email' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'display_name' => '<string>',
'company' => '<string>',
'country_code' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'tags' => [
'<string>'
],
'attributes' => [
]
]),
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"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/contacts")
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 \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"company\": \"<string>\",\n \"country_code\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"attributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"phone": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"company": "<string>",
"country_code": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"attributes": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"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>"
}
}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
Phone number in international (E.164) format, e.g. +14155552671. Display formats (+1 (415) 555-1234) and PBX-extension suffixes (+14155551234 x1234) are accepted and normalized server-side to E.164 before insert. Optional when an email (or other identifier) is supplied — a blank/empty string is treated as omitted; a non-empty value must be at least 3 characters (the E.164 floor).
Email address
First name
Last name
Display name
Company or organization
ISO 3166-1 alpha-2 country code
IANA timezone identifier
ISO 639-1 language code
Contact tags
Custom attributes