Pause a perk
POST
/sponsors/{key}/manage/perks/{perkId}/pause
Starts now and ends on its own, at most 14 days out; givers see the reason. The owner, admins and staff pause any perk; a manager pauses a perk that runs in store at their own locations and nowhere else, since a pause stops it everywhere it runs.
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*
The sponsor's slug (an old slug resolves too) or id.
Type
Requiredstring
perkId*
The perk.
Type
Requiredstring
Request Body
application/json
JSON
{
"until": "string",
"reason": "string"
}
Responses
OK
application/json
JSON
"string"