Expire a share token
POST
https://api.withpersona.com/api/v1/connect/share-tokens/:share-token-id/expire
Expires a share token, setting its status to expired and preventing further use.
Path parameters
share-token-idstringRequired
The token/ID of the share token to be expired.
Headers
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent.
Persona-VersionenumOptionalDefaults to
2023-01-05Allowed values:
Query parameters
includestringOptional
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.
fieldsmap from strings to stringsOptional
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.
Response
This endpoint returns a Share Token resource.
dataobject
A Share Token resource. The specific attributes and relationships included may vary based on the requesting organization's context.
includedlist of any or null
Excluded from the response by default. Will be an empty array when the include query parameter in the request was explicitly set to empty.
