Skip to content

Get a code (an online perk)​

POST
/perks/{perkId}/online-code

Hands the person the next one-time code from the business's list, in the same write as the use it counts as. Use it within 7 days. The team is told when it runs out, and when 10% of the list is left unless the list's low-stock alert is off. 10 new codes a minute per person.

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

perkId*
Type
string
Required
Format
"uuid"

Responses​

The code

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

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress