# Update tag

Change a tag's label or colour while preserving its stable key. System tags cannot be changed.

POST https://api.brigg.app/v1/operations/customers.UpdateTag

## Access & visibility

Allow `customers.UpdateTag` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `vocabulary_id` | string | Yes | Select the vocabulary for the record's resource_type and field. Use vocabulary_id, not its display label. [customers.ListTagVocabularies](https://developer.brigg.app/reference/customers/ListTagVocabularies). At least 1 character. At most 200 characters. |
| `key` | string | Yes | The tag's stable key. At least 1 character. At most 80 characters. |
| `label` | string | No | A new label. The key never changes. At least 1 character. At most 80 characters. |
| `color` | string or null | No | A colour token, or null for none. |

## Use stored keys, not labels

1. [List tag vocabularies](https://developer.brigg.app/reference/customers/ListTagVocabularies) and select the record's `resource_type` and `field`.
2. [List tags](https://developer.brigg.app/reference/customers/ListTags) with its `vocabulary_id`.
3. 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.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ok` | boolean | Yes | Whether the action completed successfully. |

## 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](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| 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. |
| 403 | `tag_locked` | System tags cannot be changed. |

## Next steps

- [List tag vocabularies](https://developer.brigg.app/reference/customers/ListTagVocabularies)
- [List tags](https://developer.brigg.app/reference/customers/ListTags)
- [Create tag](https://developer.brigg.app/reference/customers/CreateTag)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

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


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

#### TypeScript


```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.UpdateTag", {
  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",
    "key": "priority"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```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",
  "key": "priority"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdateTag",
    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
```

#### Response example


```json
{
  "ok": true
}
```

## JSON schemas


```json-schema-request
{
  "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](https://developer.brigg.app/reference/customers/ListTagVocabularies)."
    },
    "key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "The tag's stable key."
    },
    "label": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "A new label. The key never changes."
    },
    "color": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 32
        },
        {
          "type": "null"
        }
      ],
      "description": "A colour token, or null for none."
    }
  },
  "required": [
    "vocabulary_id",
    "key"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "vocabulary_id": "e_example",
      "key": "priority"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true
    }
  ]
}
```