Delete Property

Soft-delete a property. Values already stored on contacts are preserved in contact.properties, but the schema entry is removed and the key will no longer be surfaced through this API.

Endpoint

DELETE /properties/:id

Returns: 200 OK

Path Parameters

Parameter	Type	Description
id	string	The property ID

Response

{
  "message": "Property deleted"
}

---

Examples

cURL

curl -X DELETE "https://api.arsel.sa/v1/properties/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a" \
  -H "Authorization: Bearer be_your_api_key"

JavaScript

const propertyId = "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a";

const response = await fetch(
  `https://api.arsel.sa/v1/properties/${propertyId}`,
  {
    method: "DELETE",
    headers: { Authorization: "Bearer be_your_api_key" },
  },
);

console.log(await response.json());

Python

import requests

property_id = "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a"

response = requests.delete(
    f"https://api.arsel.sa/v1/properties/{property_id}",
    headers={"Authorization": "Bearer be_your_api_key"},
)

print(response.json())

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer be_your_api_key");

var propertyId = "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a";
var response = await client.DeleteAsync($"https://api.arsel.sa/v1/properties/{propertyId}");
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php
$propertyId = "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a";
$ch = curl_init("https://api.arsel.sa/v1/properties/{$propertyId}");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($ch);
echo $response;
curl_close($ch);

Error Responses

404 Not Found

{
  "status_code": 404,
  "name": "not_found",
  "message": "Property with id \"...\" not found"
}