Skip to main content
PUT
/
families
/
{familyID}
SDK (@phosra/sdk)
import { PhosraClient } from "@phosra/sdk";

const phosra = new PhosraClient({
  baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1",
  accessToken: process.env.PHOSRA_API_KEY,
});

const result = await phosra.families.update("f0000000-0000-4000-8000-0000000000f1", {
  name: "The Chen Household"
});
console.log(result);
{
  "id": "fcdf4277-ba14-4732-8db5-0369b2c88d8b",
  "name": "Ada's Family",
  "created_at": "2026-06-18T14:32:07Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

familyID
string<uuid>
required

Body

application/json
name
string

Response

Updated

id
string<uuid>

Unique identifier for this resource.

name
string

Human-readable display name.

created_at
string<date-time>

RFC 3339 timestamp of when the resource was created.