Tolgee Octri Demo
PUT/v2/pats/{id}

Replace a personal access token description

Replaces the description of a personal access token (PAK) identified by its numeric ID. Supply the new description value in the request body; it must contain at least one character.

1 parameter · 1 body field
idintegerrequired
The numeric ID of the personal access token whose description to replace.

The replacement description for the personal access token.

descriptionstringrequired
New description of the PAT

5 status codes
200Returns the updated PAK details, including its ID, description, and available lifecycle timestamps.
createdAtintegerrequired
descriptionstringrequired
expiresAtintegeroptional
idintegerrequired
lastUsedAtintegeroptional
updatedAtintegerrequired
400Returned when the request is malformed or the required `description` is missing or empty.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user cannot update the PAK.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when no PAK exists with the given `id`.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request is malformed or description is missing or empty. A 401 indicates that the request is not authenticated, and a 403 indicates that the authenticated user cannot update the token. A 404 is returned when the id path parameter does not identify an existing PAK.