# Rename a tag

Source: https://kirora.io/docs/api/reference/updateTag

`PATCH /v1/tags/{id}`

Requires an API key with the `tags:write` scope. [About keys and scopes](https://kirora.io/docs/api/reference/authentication)

Works with integration, agent and partner keys.

Safe to retry: a repeat sets the same values again. [About idempotency](https://kirora.io/docs/api/reference/idempotency)

Renames the tag on every item that carries it. A name another tag holds, ignoring case, is refused with 409 `ALREADY_EXISTS`: merge the two instead.

## Path parameters

- `id` (string, required, uuid) — The tag's id.

## Header parameters

- `Kirora-Workspace` (string, optional, pattern `^[A-Za-z0-9._:-]{1,128}$`) — Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

## Request body

- `name` (string, required, 1–64 characters) — The new name; unique within the workspace, ignoring case.

## Returns

Returns `200 OK` with a `Tag` in `data`. It can also return `409 Conflict`, `413 Payload Too Large` or `415 Unsupported Media Type`; see the statuses below. Otherwise returns an error; [Errors](https://kirora.io/docs/api/reference/errors) lists every code and which to retry.

- `id` (string, required, uuid)
- `name` (string, required)
- `usage` (object, required) — How many items of each kind carry the tag.
  - `campaigns` (integer, required, min 0)
  - `journeys` (integer, required, min 0)
  - `segments` (integer, required, min 0)
  - `templates` (integer, required, min 0)
- `createdAt` (string, required, date-time)
- `updatedAt` (string, required, date-time)

Statuses:

- `200 OK`: The renamed tag.
- `409 Conflict`: The request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.
- `413 Payload Too Large`: The body is larger than this operation accepts (`PAYLOAD_TOO_LARGE`).
- `415 Unsupported Media Type`: The body is not JSON, or not the upload the operation takes (`UNSUPPORTED_MEDIA_TYPE`).

## Example: Rename a tag everywhere it is used

```bash
curl -X PATCH https://api.kirora.io/v1/tags/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Black Friday 2026"
  }'
```

Response `200`:

```json
{
  "data": {
    "id": "0192f3e0-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
    "name": "Black Friday 2026",
    "usage": {
      "campaigns": 4,
      "journeys": 1,
      "segments": 2,
      "templates": 3
    },
    "createdAt": "2026-10-01T09:30:00.000Z",
    "updatedAt": "2026-10-02T14:05:00.000Z"
  }
}
```