Create a tag definition
Creates a reusable tag definition for the current organization.
/api/tag-definitionsCreates a reusable tag definition for the current organization. Tag names are case-insensitively unique inside the organization. color accepts a six-digit HEX value or a legacy preset value.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
tag-definitions:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "vip", "color": "#A855F7", "projectScope": "selected", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "createdAt": "2026-06-23T08:00:00.000Z", "updatedAt": "2026-06-23T08:00:00.000Z"}Request examples
curl
curl --request POST \
'https://api.convor.io/api/tag-definitions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"name": "vip",
"color": "#A855F7"
}'JavaScript
const response = await fetch("https://api.convor.io/api/tag-definitions", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "vip",
"color": "#A855F7"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?