Revoke Preference Form Access Tokens with REST API

Revoke a user’s access token if it becomes compromised. For example, if it’s shared or stolen.

Required Editions

Available in: Developer, Enterprise, Performance, and Unlimited Editions. Requires the Salesforce Privacy Center license.
User Permissions Needed
To use the Preference Manager Builder: ManagePreferenceManager

Syntax

URI services/data/vXX.X/consent/prefcenter/invalidtoken
Formats JSON
HTTP Methods POST
Authentication Bearer Token
Request Parameters token
Request Body

{
[token string]              // String, Required
}
Response Body

Your response body indicates if the request was successful.

  • success returns a true or false statement to indicate if the request was successful.
  • tokenErrors indicates if there was an error revoking the token. If you included multiple tokens, the response indicates any errors for each individual token.
  • error indicates if there was a system error while processing the request.

Example Response Body

{
"success" : true,
"tokenErrors" : { },
"error" : "",
}