Skip to content

Add a location​

POST
/sponsors/{key}/manage/locations

A place customers visit (pinned on the map), "We come to customers" (ZIP codes served) or "Online only". US addresses; the first is the main one. A live sponsor's new location gets its free sticker kit.

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
{
"kind": "string",
"label": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string"
},
"point": {
"lat": 0,
"lng": 0
},
"apple_place_id": "string",
"dba_id": "string",
"pickup_only": true,
"is_primary": true,
"hours": [
{
"weekday": 0,
"opens_at": "06:30",
"closes_at": "18:00"
}
],
"zips": [
"string"
]
}

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress