Create tag — Brigg developers

Access & visibility

Allow customers.CreateTag on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

vocabulary_idstringRequired

Select the vocabulary for the record's resource_type and field. Use vocabulary_id, not its display label. customers.ListTagVocabularies.

At least 1 character. At most 200 characters.

labelstringRequired

The label people see, in their language ('Vestlandet', 'VIP'). The stable key is slugged from it and returned — write THAT key onto entries, never the label.

At least 1 character. At most 80 characters.

colorstring or nullOptional

A colour token, or null for none.

Use stored keys, not labels

List tag vocabularies and select the record's resource_type and field.
List tags with its vocabulary_id.
Store the tag's key in the record field; use label and color only for display.

Renaming a label does not change its stored key. System tags are protected from update and deletion. Deleting a user tag also removes that key from affected records; entries_stripped reports how many records changed. Removing one record's tag assignment instead uses that record's update operation.

Response

Returns 200 OK with a JSON body.

tagTagRequired

Created tag, identified by its vocabulary and stable key. The label is for display.

Tag

vocabulary_idstringRequired

Vocabulary identifier.

keystringRequired

Stable key identifying this option within its collection; distinct from its display label.

labelnull or stringRequired

Human-readable label shown for this item; use its ID or key in API calls.

colornull or stringRequired

Display color assigned to this item.

systembooleanRequired

Whether this item is managed by Brigg rather than user-created.

Allowed: false, true.

sourcestringRequired

Origin or source attribution recorded for this item.

created_atnumberRequired

Creation time in Unix milliseconds.

updated_atnumberRequired

Last update time in Unix milliseconds.

createdbooleanRequired

Records newly created by the import, or whether this reusable item was newly created.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "vocabulary_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Select the vocabulary for the record's resource_type and field. Use vocabulary_id, not its display label. [customers.ListTagVocabularies](/reference/customers/ListTagVocabularies)."
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "The label people see, in their language ('Vestlandet', 'VIP'). The stable key is slugged from it and returned — write THAT key onto entries, never the label."
    },
    "color": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 32
        },
        {
          "type": "null"
        }
      ],
      "description": "A colour token, or null for none."
    }
  },
  "required": [
    "vocabulary_id",
    "label"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "vocabulary_id": "e_example",
      "label": "Priority"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "tag": {
      "description": "Created tag, identified by its vocabulary and stable key. The label is for display.",
      "title": "Tag",
      "type": "object",
      "properties": {
        "vocabulary_id": {
          "type": "string",
          "description": "Vocabulary identifier."
        },
        "key": {
          "type": "string",
          "description": "Stable key identifying this option within its collection; distinct from its display label."
        },
        "label": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "string"
            }
          ],
          "description": "Human-readable label shown for this item; use its ID or key in API calls."
        },
        "color": {
          "anyOf": [
            {
              "type": "null"
            },
            {
              "type": "string"
            }
          ],
          "description": "Display color assigned to this item."
        },
        "system": {
          "type": "boolean",
          "enum": [
            false,
            true
          ],
          "description": "Whether this item is managed by Brigg rather than user-created."
        },
        "source": {
          "type": "string",
          "description": "Origin or source attribution recorded for this item."
        },
        "created_at": {
          "type": "number",
          "description": "Creation time in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Last update time in Unix milliseconds."
        }
      },
      "required": [
        "vocabulary_id",
        "key",
        "label",
        "color",
        "system",
        "source",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    },
    "created": {
      "type": "boolean",
      "description": "Records newly created by the import, or whether this reusable item was newly created."
    }
  },
  "required": [
    "tag",
    "created"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "tag": {
        "vocabulary_id": "e_example",
        "key": "priority",
        "label": "Priority",
        "color": "green",
        "system": false,
        "source": "user",
        "created_at": 1794301200000,
        "updated_at": 1794301200000
      },
      "created": false
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.CreateTag' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "vocabulary_id": "e_example",
  "label": "Priority"
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.CreateTag", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "vocabulary_id": "e_example",
    "label": "Priority"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "vocabulary_id": "e_example",
  "label": "Priority"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreateTag",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.CreateTag' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "vocabulary_id": "e_example",
  "label": "Priority"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.CreateTag", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "vocabulary_id": "e_example",
    "label": "Priority"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "vocabulary_id": "e_example",
  "label": "Priority"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreateTag",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "tag": {
    "vocabulary_id": "e_example",
    "key": "priority",
    "label": "Priority",
    "color": "green",
    "system": false,
    "source": "user",
    "created_at": 1794301200000,
    "updated_at": 1794301200000
  },
  "created": false
}

Illustrative values, not a live response.