Create Tag

Create a new tag to label and categorize contacts for flexible targeting. Unlike lists, tags are lightweight labels — use them for attributes like "VIP", "churned", or "webinar-attendee".

Endpoint

POST /tags

Returns: 201 Created

Headers

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

Body Parameters

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

Response

{
  "id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a",
  "name": "VIP",
  "description": "High-value customers eligible for special offers",
  "contact_count": 0,
  "created_at": "2026-03-08T12:00:00.000Z",
  "updated_at": "2026-03-08T12:00:00.000Z"
}

Field	Type	Description
id	string	Unique tag ID (UUIDv7)
name	string	Tag name
description	string | null	Tag description
contact_count	number	Number of contacts currently tagged
created_at	string	ISO 8601 timestamp
updated_at	string	ISO 8601 timestamp

---

Examples

cURL

curl -X POST "https://api.arsel.sa/v1/tags" \
  -H "Authorization: Bearer $ARSEL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP",
    "description": "High-value customers eligible for special offers"
  }'

JavaScript

const response = await fetch("https://api.arsel.sa/v1/tags", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.ARSEL_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "VIP",
    description: "High-value customers eligible for special offers",
  }),
});

const data = await response.json();
if (!response.ok) {
  throw new Error(`${data.name}: ${data.message}`);
}

console.log(data);

Python

import os

import requests

response = requests.post(
    "https://api.arsel.sa/v1/tags",
    headers={"Authorization": f"Bearer {os.environ['ARSEL_API_KEY']}"},
    json={
        "name": "VIP",
        "description": "High-value customers eligible for special offers",
    },
)
response.raise_for_status()

print(response.json())

C#

using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient(); // share one instance across requests
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ARSEL_API_KEY"));

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.arsel.sa/v1/tags")
{
    Content = new StringContent(
        """
        {
          "name": "VIP",
          "description": "High-value customers eligible for special offers"
        }
        """,
        Encoding.UTF8,
        "application/json"),
};

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException($"{(int)response.StatusCode}: {body}");

Console.WriteLine(body);

PHP

<?php
$ch = curl_init("https://api.arsel.sa/v1/tags");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("ARSEL_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "name" => "VIP",
        "description" => "High-value customers eligible for special offers",
    ]),
]);

$data = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) {
    throw new Exception("{$data['name']}: {$data['message']}");
}

print_r($data);

---

Error Responses

422 Validation Error

{
  "status_code": 422,
  "name": "validation_error",
  "message": "name must match /^[a-zA-Z0-9\\s\\-_]+$/ regular expression"
}

401 Unauthorized

{
  "status_code": 401,
  "name": "unauthorized",
  "message": "Invalid API Key"
}