# Update a tag

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/tag/{id}
```

- API version: v1
- Operation ID: `v1_public_tag_update_put`
- Section: Products and catalog › [Tags](https://developer.yoprint.com/reference/tags.md)
- Web page: https://developer.yoprint.com/reference/tags/v1-tag-update-put/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Renames or recolors a tag everywhere it is used, and returns it.

Use `PUT`: it checks the fields. `PATCH` takes the same body but checks nothing.

## Permission

Any member of the team.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `id` (string, required): The tag's id (`id` from List tags). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `uAu3dAKIaHyAYk`.

## Request body

Content type `application/json`, required.

Fields:

- `color_hex` (string, optional): Matches `^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$`.
- `name` (string, optional)

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/tag/uAu3dAKIaHyAYk' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "color_hex": "#16A34A"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `color_hex` (string | null, required): Such as `#2563EB`. Null for a tag saved without a color.
  - `id` (string, required)
  - `name` (string, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "color_hex": "#16A34A",
    "id": "zzVW0sylTIm6oo",
    "name": "Wholesale"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No tag with this id in the team. `error.code` is null and `error.message` names the record type. Fix: Check the id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `PUT` only: `name` is not a string, or `color_hex` is not `#RGB` or `#RRGGBB`. `error.code` is `validation_failed`. Fix: Send a hex color.

## Related

- [List tags](https://developer.yoprint.com/reference/tags/v1-tag-index.md): `GET /v1/api/store/{team_slug}/tag`