Update Tag

Update a tag's name or description.

Endpoint

PATCH /tags/:id

Returns: 200 OK

Headers

Header	Value	Required
Authorization	Bearer <your-api-key>	Yes
Content-Type	application/json	Yes

Path Parameters

Parameter	Type	Description
id	string	The tag ID

Body Parameters

Parameter	Type	Required	Description
name	string	No	Updated tag name. Max 100 characters. Only letters, numbers, spaces, hyphens, and underscores.
description	string	No	Updated description.

Response

{
  "id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
  "name": "VIP-Gold",
  "description": "Top-tier VIP customers",
  "contact_count": 1250,
  "created_at": "2026-03-08T12:00:00.000Z",
  "updated_at": "2026-03-09T14:30:00.000Z"
}

See Create Tag for the field reference.

---

Examples

cURL

curl -X PATCH "https://api.arsel.sa/v1/tags/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a" \
  -H "Authorization: Bearer be_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP-Gold",
    "description": "Top-tier VIP customers"
  }'

JavaScript

const response = await fetch(
  "https://api.arsel.sa/v1/tags/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
  {
    method: "PATCH",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer be_your_api_key",
    },
    body: JSON.stringify({
      name: "VIP-Gold",
      description: "Top-tier VIP customers",
    }),
  }
);

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

Python

import requests

response = requests.patch(
    "https://api.arsel.sa/v1/tags/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer be_your_api_key",
    },
    json={
        "name": "VIP-Gold",
        "description": "Top-tier VIP customers",
    },
)

print(response.json())

C#

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

var payload = new { name = "VIP-Gold", description = "Top-tier VIP customers" };
var json = System.Text.Json.JsonSerializer.Serialize(payload);
var content = new StringContent(json, System.Text.Encoding.UTF8, "application/json");
var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.arsel.sa/v1/tags/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a")
{
    Content = content
};
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php
$ch = curl_init("https://api.arsel.sa/v1/tags/01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer be_your_api_key"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "name" => "VIP-Gold",
    "description" => "Top-tier VIP customers"
]));
$response = curl_exec($ch);
echo $response;
curl_close($ch);

---

Error Responses

404 Not Found

{
  "status_code": 404,
  "name": "not_found",
  "message": "Tag not found"
}

409 Conflict

{
  "status_code": 409,
  "name": "conflict",
  "message": "Tag name already exists"
}

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid or missing API key"
}