Flambe docs
API referenceHouseholds

Accept an invite

Redeems an invite token and joins the caller to the household. Requires authentication — the invite is bound to whoever accepts it.

POST
/api/households/invites/{token}/accept

Redeems an invite token and joins the caller to the household. Requires authentication — the invite is bound to whoever accepts it.

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

token*string

The invite's token.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/households/invites/string/accept"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "members": [    {      "user_id": "string",      "role": "owner",      "joined_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Update a grocery list PUT

Supplying `items` replaces the whole item list — this is how a client persists check-offs and edits in one call.

Replace the grants for a resource type PUT

Sets the complete set of grants for one resource type in a single call. Anything the caller had shared that is absent from `grants` is revoked, which is what makes this safe to drive from a checkbox list.