Add a contact
curl --request POST \
--url https://api-eg.olimi.ai/api/v2/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"phoneNumber": "+201001234567",
"firstName": "Ahmed",
"lastName": "Hassan",
"email": "[email protected]",
"gender": "male",
"variantValues": [
{
"variantId": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"value": "ORD-10492"
}
]
}
'import requests
url = "https://api-eg.olimi.ai/api/v2/contacts"
payload = {
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"phoneNumber": "+201001234567",
"firstName": "Ahmed",
"lastName": "Hassan",
"email": "[email protected]",
"gender": "male",
"variantValues": [
{
"variantId": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"value": "ORD-10492"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerListId: '9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24',
phoneNumber: '+201001234567',
firstName: 'Ahmed',
lastName: 'Hassan',
email: '[email protected]',
gender: 'male',
variantValues: [{variantId: '7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60', value: 'ORD-10492'}]
})
};
fetch('https://api-eg.olimi.ai/api/v2/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-eg.olimi.ai/api/v2/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([
'customerListId' => '9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24',
'phoneNumber' => '+201001234567',
'firstName' => 'Ahmed',
'lastName' => 'Hassan',
'email' => '[email protected]',
'gender' => 'male',
'variantValues' => [
[
'variantId' => '7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60',
'value' => 'ORD-10492'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/contacts"
payload := strings.NewReader("{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/contacts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Contact created successfully",
"data": {
"id": "b2f7c4e1-8a3d-4c59-9e06-1d5a7f3b8c42",
"customerId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"firstName": "Ahmed",
"lastName": "Hassan",
"phoneNumber": "+201001234567",
"email": "[email protected]",
"gender": "male",
"retries": 0,
"lastCallStatus": "not_called",
"callbackScheduled": false,
"callbackAt": null,
"variantValues": [
{
"id": "4d8e2a6f-1c7b-4e93-a5d0-8f2b6c1e9a37",
"value": "ORD-10492",
"variant": {
"id": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"name": "Order number",
"slug": "order_number"
}
}
],
"createdAt": "2026-09-20T08:14:22.531Z",
"updatedAt": "2026-09-27T11:40:09.118Z",
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24"
}
}{
"statusCode": 400,
"errorCode": "contact_duplicate_phone_number",
"message": "A contact with this phone number already exists",
"data": {
"existingContactId": "b2f7c4e1-8a3d-4c59-9e06-1d5a7f3b8c42"
}
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Contacts
Add a contact
Adds one contact to a customer list. If the list is part of a running campaign, the new contact is picked up for calling.
POST
/
api
/
v2
/
contacts
Add a contact
curl --request POST \
--url https://api-eg.olimi.ai/api/v2/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"phoneNumber": "+201001234567",
"firstName": "Ahmed",
"lastName": "Hassan",
"email": "[email protected]",
"gender": "male",
"variantValues": [
{
"variantId": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"value": "ORD-10492"
}
]
}
'import requests
url = "https://api-eg.olimi.ai/api/v2/contacts"
payload = {
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"phoneNumber": "+201001234567",
"firstName": "Ahmed",
"lastName": "Hassan",
"email": "[email protected]",
"gender": "male",
"variantValues": [
{
"variantId": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"value": "ORD-10492"
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerListId: '9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24',
phoneNumber: '+201001234567',
firstName: 'Ahmed',
lastName: 'Hassan',
email: '[email protected]',
gender: 'male',
variantValues: [{variantId: '7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60', value: 'ORD-10492'}]
})
};
fetch('https://api-eg.olimi.ai/api/v2/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-eg.olimi.ai/api/v2/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([
'customerListId' => '9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24',
'phoneNumber' => '+201001234567',
'firstName' => 'Ahmed',
'lastName' => 'Hassan',
'email' => '[email protected]',
'gender' => 'male',
'variantValues' => [
[
'variantId' => '7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60',
'value' => 'ORD-10492'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/contacts"
payload := strings.NewReader("{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/contacts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerListId\": \"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24\",\n \"phoneNumber\": \"+201001234567\",\n \"firstName\": \"Ahmed\",\n \"lastName\": \"Hassan\",\n \"email\": \"[email protected]\",\n \"gender\": \"male\",\n \"variantValues\": [\n {\n \"variantId\": \"7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60\",\n \"value\": \"ORD-10492\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Contact created successfully",
"data": {
"id": "b2f7c4e1-8a3d-4c59-9e06-1d5a7f3b8c42",
"customerId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"firstName": "Ahmed",
"lastName": "Hassan",
"phoneNumber": "+201001234567",
"email": "[email protected]",
"gender": "male",
"retries": 0,
"lastCallStatus": "not_called",
"callbackScheduled": false,
"callbackAt": null,
"variantValues": [
{
"id": "4d8e2a6f-1c7b-4e93-a5d0-8f2b6c1e9a37",
"value": "ORD-10492",
"variant": {
"id": "7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60",
"name": "Order number",
"slug": "order_number"
}
}
],
"createdAt": "2026-09-20T08:14:22.531Z",
"updatedAt": "2026-09-27T11:40:09.118Z",
"customerListId": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24"
}
}{
"statusCode": 400,
"errorCode": "contact_duplicate_phone_number",
"message": "A contact with this phone number already exists",
"data": {
"existingContactId": "b2f7c4e1-8a3d-4c59-9e06-1d5a7f3b8c42"
}
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Phone numbers are checked and stored in international format. See Phone numbers. To set custom field values, see Custom fields.
If the customer list doesn’t allow duplicates, a phone number that’s already in it is rejected with
contact_duplicate_phone_number, and data.existingContactId tells you which contact has it. Duplicates are allowed or not per list, in the Dashboard.
The response includes customerListId, the same value as customerId.
Common causes of a 422 validation error:
phoneNumberis missing or longer than 50 characters.emailisn’t a valid email address, or is longer than 50 characters.firstNameorlastNameis longer than 100 characters.- An item in
variantValuesis missingvariantIdorvalue.
Authorizations
Body
application/json
The customer list to add the contact to.
Example:
"9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24"
Maximum string length:
100Example:
"Ahmed"
Maximum string length:
100Example:
"Hassan"
Maximum string length:
50Example:
Free text.
Maximum string length:
50Example:
"male"
Custom field values. See Custom fields.
Show child attributes
Show child attributes