Update a client-side token

patchhttps://api.paddle.com/client-tokens/{client_token_id}

Updates a client-side token using its ID.

You can revoke a client-side token by changing its status to revoked. Client-side tokens that are revoked can't be updated to active.

If successful, your response includes a copy of the updated client-side token entity.

Path Parameters

client_token_idstringrequired

Paddle ID of the client-side token entity.

Request Body

statusstringrequired

Status of this client-side token.

Response

dataobject

Represents a client-side token entity.

idstring

Unique Paddle ID for this client-side token entity, prefixed with ctkn_. Not used for Paddle.js authentication; use token for authentication.

tokenstring

A client-side token, prefixed with test or live depending on the environment of your account. Pass as the token parameter when initializing Paddle.js to authenticate.

namestring

Short name of this client-side token. Typically unique and human-identifiable.

descriptionstring or null

Short description of this client-side token. Typically gives details about what the token is used for and where it's used.

statusstring

Status of this client-side token.

revoked_atstring<date-time> or null

RFC 3339 datetime string of when this client-side token was revoked. null if not revoked.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

Request

1
2
3
1{
2  "status": "revoked"
3}

Response