Skip to content

What sending a perk's terms would do​

POST
/sponsors/{key}/manage/perks/preview

Owner, admins and staff. Nothing is written. The outcome submit would reach for these terms: live (now), scheduled (a change that takes something from givers waits 14 days; smaller says why, and told how many givers hear of it today: the sponsor's followers and the perk's users in 90 days, null under 10 with fewer_than: 10), in_review (a person reads it first, with the flags; staff's perks always), or draft while the sponsor isn't live. The terms are checked as on save (422 naming the field).

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
{
"terms": {
"additionalProperties": "string"
},
"perk_id": "string"
}

Responses​

OK

application/json
JSON
{
"outcome": "string",
"effective_at": "string",
"smaller": [
"string"
],
"flags": [
"string"
],
"told": {
"count": 0,
"fewer_than": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress