Skip to content

Invite a business by email​

POST
/me/referrals/businesses/invites

Emails a business an invite from the caller: what being a sponsor is, and a link of its own that marks the invite opened and lands on For businesses with the caller's ref. One invite per address; twenty new addresses a day. The link's token is only ever in the email.

Requires permission: view_own_referral_portal.

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)

Request Body​

application/json
JSON
{
"businessName": "string",
"email": "string",
"categoryId": "string",
"area": "string"
}

Responses​

Sent

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

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress