Flambe docs
API referenceHouseholds

Set sharing preferences

PUT
/api/households/{id}/sharing/preferences

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
Formatuuid

Request 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 PUT "https://example.com/api/households/497f6eca-6276-4993-bfeb-53cbbbba6f08/sharing/preferences" \  -H "Content-Type: application/json" \  -d '{    "preferences": {}  }'
{  "preferences": {}}