Skip to content

Pause every perk​

POST
/sponsors/{key}/manage/settings/pause

Starts now and comes back on the date picked, up to 60 days out; while paused, moves the date. With from more than a minute ahead (up to 90 days), the pause is planned instead and the hourly sponsor run starts it on the day; pausing now drops a plan. Publishes sponsor.status_changed when a pause starts.

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
string
Required

Request Body​

application/json
JSON
{
"until": "string",
"from": "string",
"message": "string"
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress