POST
Create manual address

Authorizations

x-api-key
string
header
required

Headers

x-tenant
string
required

Tenant identifier

Path Parameters

entityId
string
required

Body

application/json
cityId
string
required

Unique identifier of the city. Can be retrieved from the Cities API.

Example:

"543facc0-dc76-4ddf-81cd-4e3aa95a8acb"

districtName
string
required

Name of the district or neighborhood within the selected city.

Example:

"Al Olaya"

attachmentId
string
required
streetNameEn
string

Street name in English. Optional if the Arabic name is provided.

Example:

"King Fahd Road"

streetNameAr
string

Street name in Arabic. Optional if the English name is provided.

Example:

"طريق الملك فهد"

unitNumber
string

Unit, apartment, or villa number within the building.

Example:

"305"

fullAddress
string

Full address as a single string (optional, in addition to structured fields)

Example:

"123 King Fahd Road, Al Olaya, Riyadh, Saudi Arabia"

Response

Success

data
object
required
creationStatus
enum<string>
Available options:
Created,
Invalid,
Existing