clientTokenVersions

Create a New Client Token Version

Rotates a Client Token by creating a new version without disabling existing versions. A Client Token can have up to five usable versions; disable an existing version before rotating if the limit has been reached. The new version's value is returned in the included response data. Copy the value when you create the version, then update your integrations to use it.

post/client-tokens/{client-token-id}/rotate

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/client-tokens/{client-token-id}/rotate
  • Auth: HTTP bearer

Path parameters

client-token-idstring required

The ID of the client token to be rotated.

Query parameters

includestring

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Request body

Response

This endpoint returns a Client Token.

Changes

No recorded changes to this operation across all 1 revision of this API.