WIwithpersona
connect

Expire a Share Token

Changed on

Expires a Share Token, setting its status to expired and preventing further use.

post/connect/share-tokens/{share-token-id}/expire

Request

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

Path parameters

share-token-idstring required

The token/ID of the Share Token to be expired.

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.

Response

This endpoint returns a Share Token resource.

Changes

  • 0281de74819eRevision changes
    • breaking

      added subschema #1 subschema #5 subschema #6 subschema #7 to the // response property oneOf list for the response status

    • info

      removed subschema #1 from the // response property oneOf list for the response status

  • f3b8c7e87b77Revision changes
    • breaking

      added subschema #15 subschema #16 subschema #17 to the // response property oneOf list for the response status