API Reference

Manually cause a consent object to expire

post
https://app.standardcode.io/api/v1/consents//expire

Use this endpoint to manually expire a consent object. This endpoint will set the expires_at property of the consent object to the current time, thus expiring it.

If the consent object has already been expired (i.e. the expires_at time is already in the past), then nothing is changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The key of the consent object to expire.

Body Params
boolean
Defaults to true

Indicates whether or not a webhook event should be sent to notify your application that the consent has been expired.

boolean
Defaults to false

By default, a new webhook event is not sent if a previous one has already been sent for this consent object. However, you can set this parameter to true to force another webhook event to be sent.

Responses

expires_at timestamp will be set to the current time.

Updated over 4 years ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 4 years ago

Did this page help you?