Skip to content

Give a use back​

POST
/sponsors/{key}/manage/uses/{useId}/void

For a perk the business didn't honor: the person gets the use back. The owner and admins. Not while a report about it waits for an answer; answer the report instead. The reason is kept with the use (Perks used shows it under "Undone") and in the audit row.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

key*
Type
string
Required
useId*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"reason": "string"
}

Responses​

Voided

application/json
JSON
{
"data": {
"useId": "string",
"voidedAt": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress