Skip to content
/
Update a Tag

Update a Tag

Request

Renames a tag in the organization's tag list. The new name is applied to every entity that had previously been given the current tag, which can take additional time to be reflected across the system. If the current tag names a category (ends with ::), every tag within that category is renamed to use the new category name as well. Tags are compared case-insensitively.

Security
ApiKey
Body
current_tagstringrequired

The existing tag to rename.

Tag names are structured as CATEGORY::TAG_NAME, with a :: separating the category and tag name. Category names will be returned with :: in their name.

Example: Skills:: would indicate a category named skills. Further, Skills::ActionScript would indicate a tag named ActionScript within the Skills category.

New category and tag names may not start or end with whitespace, so creating Skills:: ActionScript is rejected. Whitespace within a name is allowed: Front End::Dust Bringer is valid.

updated_tagstringrequired

The new value for the tag.

Tag names are structured as CATEGORY::TAG_NAME, with a :: separating the category and tag name. Category names will be returned with :: in their name.

Example: Skills:: would indicate a category named skills. Further, Skills::ActionScript would indicate a tag named ActionScript within the Skills category.

New category and tag names may not start or end with whitespace, so creating Skills:: ActionScript is rejected. Whitespace within a name is allowed: Front End::Dust Bringer is valid.

curl -i -X POST \
  https://developer.getparallax.com/_mock/api-documentation/swagger/v1/tags/rename \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "current_tag": "string",
    "updated_tag": "string"
  }'

Responses

No Content

Response
No content