Skip to main content
POST
/
families
/
{familyID}
/
members
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.members.invite("f0000000-0000-4000-8000-0000000000f1", {
  user_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  role: "guardian"
});
console.log(result);
{
  "status": "active"
}

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
user_id
string<uuid>
required

User UUID to add

role
enum<string>
required
Available options:
owner,
parent,
guardian

Response

Member added

status
string