Client Entities
Bulk create clients
Submit multiple clients for bulk creation and enrollment into monitoring workflows
POST
/
entities
/
client
/
bulk
Bulk create clients
curl --request POST \
--url https://app.api.getdal.sa/services/crm/entities/client/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"clients": [
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": [
"<string>"
]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": [
"<string>"
],
"ongoingMonitoring": true
}
],
"tagIds": [
"<string>"
]
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/client/bulk"
payload = {
"clients": [
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": ["<string>"]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": ["<string>"],
"ongoingMonitoring": True
}
],
"tagIds": ["<string>"]
}
headers = {
"x-tenant": "<x-tenant>",
"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-tenant': '<x-tenant>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clients: [
{
identities: [
{
number: 'A123456789',
subtype: '<string>',
expiresAt: '2030-12-31',
issuingCountryCode: 'SA',
documentIds: ['<string>']
}
],
nameEn: 'John Michael Doe',
nameAr: 'جون ميخائيل دو',
email: 'john.doe@example.com',
countryCode: '966',
phoneNumber: '501234567',
accountOpenDate: '2025-06-15',
dobGregorian: '1990-05-20',
dobHijri: '1410-10-15',
dateOfIncorporationGregorian: '2005-09-30',
dateOfIncorporationHijri: '1426-08-20',
nationalityCode: 'SA',
crmId: '550e8400-e29b-41d4-a716-446655440000',
tagIds: ['<string>'],
ongoingMonitoring: true
}
],
tagIds: ['<string>']
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/client/bulk', 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://app.api.getdal.sa/services/crm/entities/client/bulk",
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([
'clients' => [
[
'identities' => [
[
'number' => 'A123456789',
'subtype' => '<string>',
'expiresAt' => '2030-12-31',
'issuingCountryCode' => 'SA',
'documentIds' => [
'<string>'
]
]
],
'nameEn' => 'John Michael Doe',
'nameAr' => 'جون ميخائيل دو',
'email' => 'john.doe@example.com',
'countryCode' => '966',
'phoneNumber' => '501234567',
'accountOpenDate' => '2025-06-15',
'dobGregorian' => '1990-05-20',
'dobHijri' => '1410-10-15',
'dateOfIncorporationGregorian' => '2005-09-30',
'dateOfIncorporationHijri' => '1426-08-20',
'nationalityCode' => 'SA',
'crmId' => '550e8400-e29b-41d4-a716-446655440000',
'tagIds' => [
'<string>'
],
'ongoingMonitoring' => true
]
],
'tagIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-tenant: <x-tenant>"
],
]);
$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://app.api.getdal.sa/services/crm/entities/client/bulk"
payload := strings.NewReader("{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant", "<x-tenant>")
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://app.api.getdal.sa/services/crm/entities/client/bulk")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/client/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant"] = '<x-tenant>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"quota": {
"message": "<string>",
"code": "HARD_THRESHOLD_REACHED",
"remaining": 123
},
"jobId": "1"
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
},
"validationErrors": [
"<string>"
]
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}Authorizations
Headers
Tenant identifier
Body
application/json
⌘I
Bulk create clients
curl --request POST \
--url https://app.api.getdal.sa/services/crm/entities/client/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"clients": [
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": [
"<string>"
]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": [
"<string>"
],
"ongoingMonitoring": true
}
],
"tagIds": [
"<string>"
]
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/client/bulk"
payload = {
"clients": [
{
"identities": [
{
"number": "A123456789",
"subtype": "<string>",
"expiresAt": "2030-12-31",
"issuingCountryCode": "SA",
"documentIds": ["<string>"]
}
],
"nameEn": "John Michael Doe",
"nameAr": "جون ميخائيل دو",
"email": "john.doe@example.com",
"countryCode": "966",
"phoneNumber": "501234567",
"accountOpenDate": "2025-06-15",
"dobGregorian": "1990-05-20",
"dobHijri": "1410-10-15",
"dateOfIncorporationGregorian": "2005-09-30",
"dateOfIncorporationHijri": "1426-08-20",
"nationalityCode": "SA",
"crmId": "550e8400-e29b-41d4-a716-446655440000",
"tagIds": ["<string>"],
"ongoingMonitoring": True
}
],
"tagIds": ["<string>"]
}
headers = {
"x-tenant": "<x-tenant>",
"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-tenant': '<x-tenant>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
clients: [
{
identities: [
{
number: 'A123456789',
subtype: '<string>',
expiresAt: '2030-12-31',
issuingCountryCode: 'SA',
documentIds: ['<string>']
}
],
nameEn: 'John Michael Doe',
nameAr: 'جون ميخائيل دو',
email: 'john.doe@example.com',
countryCode: '966',
phoneNumber: '501234567',
accountOpenDate: '2025-06-15',
dobGregorian: '1990-05-20',
dobHijri: '1410-10-15',
dateOfIncorporationGregorian: '2005-09-30',
dateOfIncorporationHijri: '1426-08-20',
nationalityCode: 'SA',
crmId: '550e8400-e29b-41d4-a716-446655440000',
tagIds: ['<string>'],
ongoingMonitoring: true
}
],
tagIds: ['<string>']
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/client/bulk', 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://app.api.getdal.sa/services/crm/entities/client/bulk",
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([
'clients' => [
[
'identities' => [
[
'number' => 'A123456789',
'subtype' => '<string>',
'expiresAt' => '2030-12-31',
'issuingCountryCode' => 'SA',
'documentIds' => [
'<string>'
]
]
],
'nameEn' => 'John Michael Doe',
'nameAr' => 'جون ميخائيل دو',
'email' => 'john.doe@example.com',
'countryCode' => '966',
'phoneNumber' => '501234567',
'accountOpenDate' => '2025-06-15',
'dobGregorian' => '1990-05-20',
'dobHijri' => '1410-10-15',
'dateOfIncorporationGregorian' => '2005-09-30',
'dateOfIncorporationHijri' => '1426-08-20',
'nationalityCode' => 'SA',
'crmId' => '550e8400-e29b-41d4-a716-446655440000',
'tagIds' => [
'<string>'
],
'ongoingMonitoring' => true
]
],
'tagIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-tenant: <x-tenant>"
],
]);
$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://app.api.getdal.sa/services/crm/entities/client/bulk"
payload := strings.NewReader("{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-tenant", "<x-tenant>")
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://app.api.getdal.sa/services/crm/entities/client/bulk")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/client/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-tenant"] = '<x-tenant>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clients\": [\n {\n \"identities\": [\n {\n \"number\": \"A123456789\",\n \"subtype\": \"<string>\",\n \"expiresAt\": \"2030-12-31\",\n \"issuingCountryCode\": \"SA\",\n \"documentIds\": [\n \"<string>\"\n ]\n }\n ],\n \"nameEn\": \"John Michael Doe\",\n \"nameAr\": \"جون ميخائيل دو\",\n \"email\": \"john.doe@example.com\",\n \"countryCode\": \"966\",\n \"phoneNumber\": \"501234567\",\n \"accountOpenDate\": \"2025-06-15\",\n \"dobGregorian\": \"1990-05-20\",\n \"dobHijri\": \"1410-10-15\",\n \"dateOfIncorporationGregorian\": \"2005-09-30\",\n \"dateOfIncorporationHijri\": \"1426-08-20\",\n \"nationalityCode\": \"SA\",\n \"crmId\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"tagIds\": [\n \"<string>\"\n ],\n \"ongoingMonitoring\": true\n }\n ],\n \"tagIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"quota": {
"message": "<string>",
"code": "HARD_THRESHOLD_REACHED",
"remaining": 123
},
"jobId": "1"
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
},
"validationErrors": [
"<string>"
]
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}{
"errorCode": "NOT_FOUND",
"message": {
"en": "The requested record was not found",
"ar": "لم يتم العثور على السجل المطلوب"
}
}