API referenceHouseholds
Invite someone to a household
Invite by `recipient_email` for someone who may not have an account yet, or by `recipient_user_id` for an existing Flambe user.
Invite by recipient_email for someone who may not have an account
yet, or by recipient_user_id for an existing Flambe user.
Authorization
bearerAuth AuthorizationBearer <token>
A Clerk session JWT. Obtain one with a Clerk frontend SDK
(session.getToken()) or, for server-to-server use, with a Clerk
machine token. The token's sub claim is the Flambe user id that scopes
every request.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/households/497f6eca-6276-4993-bfeb-53cbbbba6f08/invites" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "household_id": "f01c6697-3de0-4446-8e7d-4bffe5f9377b", "recipient_email": "user@example.com", "recipient_user_id": "string", "role": "admin", "token": "string", "status": "pending", "created_at": "2019-08-24T14:15:22Z"}