Create a tag

PUT

https://api.contentful.com/spaces/:space_id/environments/:environment_id/tags/:tag_id

PUT

/spaces/:space_id/environments/:environment_id/tags/:tag_id

$ curl -X PUT https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/tags/nyCampaign \
>      -H "X-Contentful-Tag-Visibility: public" \
>      -H "X-Contentful-Version: 1" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/vnd.contentful.management.v1+json" \
>      -d '{
>   "name": "NY Campaign",
>   "sys": {
>     "visibility": "public",
>     "id": "nyCampaign",
>     "type": "Tag"
>   }
> }'

201Tags_createATag_example

1 {
2   "name": "NY Campaign",
3   "sys": {
4     "visibility": "public",
5     "type": "Tag",
6     "id": "nyCampaign",
7     "version": 1,
8     "space": {
9       "sys": {
10         "type": "Link",
11         "linkType": "Space",
12         "id": "yadj1kx9rmg0"
13       }
14     },
15     "environment": {
16       "sys": {
17         "type": "Link",
18         "linkType": "Environment",
19         "id": "staging"
20       }
21     },
22     "createdAt": "2025-02-09T07:02:05.000Z",
23     "createdBy": {
24       "sys": {
25         "type": "Link",
26         "linkType": "User",
27         "id": "7BslKh9TdKGOK41VmLDjFZ"
28       }
29     },
30     "updatedAt": "2025-02-09T07:02:05.000Z",
31     "updatedBy": {
32       "sys": {
33         "type": "Link",
34         "linkType": "User",
35         "id": "4FLrUHftHW3v2BLi9fzfjU"
36       }
37     }
38   }
39 }

Creates or updates a tag; tag IDs are immutable after creation. Set visibility via X-Contentful-Tag-Visibility header (defaults to private).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in the form of a string

environment_idstringRequired

ID of the environment in form of a string

tag_idstringRequired

ID of the tag in form of a string

Headers

X-Contentful-Tag-VisibilitystringOptional

The tag visibility can be set in the header with this header. The visibility value set in the header overrides that in the payload.

X-Contentful-VersionstringOptional

Version of the tag to update

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

Created - Resource created successfully