Rename a tag
Renames the tag on every resource and assistant that carries it, in one batch. When the new name already exists the two tags are merged. Workspace admins only, through a personal connection.
POST/v1/tags/rename
Requires admin.
Workspace admins only, with a personal connection. An API key never holds the admin scope.
The tag is renamed on every resource and every assistant that carries or follows it, in one step. Renaming to an existing name merges the two tags. A tag that does not exist fails with resource_not_found.
Authorizations
Authorizationbearerin headerrequiredHeader parameters
Idempotency-Keystringlength: 1–255 charsA unique key for this request, such as a UUID, 1 to 255 visible ASCII characters. Send the same key when you retry: the first response is returned (with Idempotent-Replayed: true) instead of running the request again, for 24 hours, per credential. The same key on a different request is a 409 conflict. A streamed answer is not recorded.
Body
application/jsonrequiredfromstringrequiredlength: 1–60 charsThe tag to rename, exactly as listed.
tostringrequiredlength: 1–60 charsThe new name. When it already exists, the two tags are merged.
Response
Rename a tag
dataobjectrequiredrequest_idstringrequiredPossible codes: invalid_request, unknown_field, invalid_parameter, invalid_cursor
errorobjectrequiredrequest_idstringrequiredPossible codes: authentication_required, invalid_api_key, api_key_expired, api_key_revoked, invalid_access_key
errorobjectrequiredrequest_idstringrequiredPossible codes: insufficient_scope, feature_not_available, admin_required, permission_denied
errorobjectrequiredrequest_idstringrequiredPossible codes: resource_not_found
errorobjectrequiredrequest_idstringrequiredPossible codes: conflict, assistant_has_no_resources
errorobjectrequiredrequest_idstringrequiredPossible codes: request_too_large
errorobjectrequiredrequest_idstringrequiredPossible codes: rate_limited
errorobjectrequiredrequest_idstringrequiredPossible codes: internal_error
errorobjectrequiredrequest_idstringrequired