Create a household
The caller becomes the owner.
The caller becomes the owner.
Authorization
bearerAuth 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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/households" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}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.
Invite someone to a household POST
Invite by `recipient_email` for someone who may not have an account yet, or by `recipient_user_id` for an existing Flambe user.