Addresses
Create manual address
Create an entity address manually, including a supporting document for admin review
POST
/
entities
/
{entityId}
/
addresses
/
manual
Create manual address
curl --request POST \
--url https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"cityId": "543facc0-dc76-4ddf-81cd-4e3aa95a8acb",
"districtName": "Al Olaya",
"attachmentId": "<string>",
"streetNameEn": "King Fahd Road",
"streetNameAr": "طريق الملك فهد",
"unitNumber": "305",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual"
payload = {
"cityId": "543facc0-dc76-4ddf-81cd-4e3aa95a8acb",
"districtName": "Al Olaya",
"attachmentId": "<string>",
"streetNameEn": "King Fahd Road",
"streetNameAr": "طريق الملك فهد",
"unitNumber": "305",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"
}
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({
cityId: '543facc0-dc76-4ddf-81cd-4e3aa95a8acb',
districtName: 'Al Olaya',
attachmentId: '<string>',
streetNameEn: 'King Fahd Road',
streetNameAr: 'طريق الملك فهد',
unitNumber: '305',
fullAddress: '123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia'
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual', 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/{entityId}/addresses/manual",
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([
'cityId' => '543facc0-dc76-4ddf-81cd-4e3aa95a8acb',
'districtName' => 'Al Olaya',
'attachmentId' => '<string>',
'streetNameEn' => 'King Fahd Road',
'streetNameAr' => 'طريق الملك فهد',
'unitNumber' => '305',
'fullAddress' => '123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia'
]),
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/{entityId}/addresses/manual"
payload := strings.NewReader("{\n \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\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/{entityId}/addresses/manual")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual")
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 \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"district": "Al Olaya",
"districtArea": "Central Riyadh",
"districtName": "King Fahd Road",
"locationX": "24.7136",
"locationY": "46.6753",
"locationZ": "1",
"phoneNumber": "+966501234567",
"streetNameEn": "King Abdullah Street",
"streetNameAr": "شارع الملك عبدالله",
"latitude": "24.7136",
"longitude": "46.6753",
"unitNumber": "305",
"unitTypeId": "apt-ksa-01",
"shortCode": "RRRDD2929",
"status": "Submitted",
"source": "Automatic",
"category": "Local",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"city": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Riyadh",
"nameAr": "الرياض"
}
},
"creationStatus": "Created"
}{
"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
Path Parameters
Body
application/json
Unique identifier of the city. Can be retrieved from the Cities API.
Example:
"543facc0-dc76-4ddf-81cd-4e3aa95a8acb"
Name of the district or neighborhood within the selected city.
Example:
"Al Olaya"
Street name in English. Optional if the Arabic name is provided.
Example:
"King Fahd Road"
Street name in Arabic. Optional if the English name is provided.
Example:
"طريق الملك فهد"
Unit, apartment, or villa number within the building.
Example:
"305"
Full address as a single string (optional, in addition to structured fields)
Example:
"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"
⌘I
Create manual address
curl --request POST \
--url https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-tenant: <x-tenant>' \
--data '
{
"cityId": "543facc0-dc76-4ddf-81cd-4e3aa95a8acb",
"districtName": "Al Olaya",
"attachmentId": "<string>",
"streetNameEn": "King Fahd Road",
"streetNameAr": "طريق الملك فهد",
"unitNumber": "305",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"
}
'import requests
url = "https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual"
payload = {
"cityId": "543facc0-dc76-4ddf-81cd-4e3aa95a8acb",
"districtName": "Al Olaya",
"attachmentId": "<string>",
"streetNameEn": "King Fahd Road",
"streetNameAr": "طريق الملك فهد",
"unitNumber": "305",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"
}
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({
cityId: '543facc0-dc76-4ddf-81cd-4e3aa95a8acb',
districtName: 'Al Olaya',
attachmentId: '<string>',
streetNameEn: 'King Fahd Road',
streetNameAr: 'طريق الملك فهد',
unitNumber: '305',
fullAddress: '123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia'
})
};
fetch('https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual', 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/{entityId}/addresses/manual",
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([
'cityId' => '543facc0-dc76-4ddf-81cd-4e3aa95a8acb',
'districtName' => 'Al Olaya',
'attachmentId' => '<string>',
'streetNameEn' => 'King Fahd Road',
'streetNameAr' => 'طريق الملك فهد',
'unitNumber' => '305',
'fullAddress' => '123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia'
]),
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/{entityId}/addresses/manual"
payload := strings.NewReader("{\n \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\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/{entityId}/addresses/manual")
.header("x-tenant", "<x-tenant>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.api.getdal.sa/services/crm/entities/{entityId}/addresses/manual")
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 \"cityId\": \"543facc0-dc76-4ddf-81cd-4e3aa95a8acb\",\n \"districtName\": \"Al Olaya\",\n \"attachmentId\": \"<string>\",\n \"streetNameEn\": \"King Fahd Road\",\n \"streetNameAr\": \"طريق الملك فهد\",\n \"unitNumber\": \"305\",\n \"fullAddress\": \"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"district": "Al Olaya",
"districtArea": "Central Riyadh",
"districtName": "King Fahd Road",
"locationX": "24.7136",
"locationY": "46.6753",
"locationZ": "1",
"phoneNumber": "+966501234567",
"streetNameEn": "King Abdullah Street",
"streetNameAr": "شارع الملك عبدالله",
"latitude": "24.7136",
"longitude": "46.6753",
"unitNumber": "305",
"unitTypeId": "apt-ksa-01",
"shortCode": "RRRDD2929",
"status": "Submitted",
"source": "Automatic",
"category": "Local",
"fullAddress": "123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia",
"attachment": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"name": "logo.png",
"mimeType": "image/png",
"size": "1436",
"createdBy": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"email": "<string>",
"displayName": "<string>",
"roleId": "<string>"
}
},
"city": {
"id": "b50c7893-cd88-42bd-9fdd-b94f493315f9",
"createdAt": "2025-12-02 12:00:00.000",
"updatedAt": "2025-12-04 12:00:00.000",
"nameEn": "Riyadh",
"nameAr": "الرياض"
}
},
"creationStatus": "Created"
}{
"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": "لم يتم العثور على السجل المطلوب"
}
}