Class Manager
POST /v1/families/{id}/invite

Invite Family

Path parameters

  • id string Required

    Family id

application/json

Body

Request for inviting a Family for Portal access

  • firstname string

    First name of the Primary Contact to set on the Family

  • lastname string

    Last name of the Primary Contact to set on the Family

  • email string

    Email address of the Primary Contact to set on the Family

Responses

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • type string Required

      Values are staff_invitation or family_invitation.

    • companyId string Required

      Company ID

    • entityId string Required

      Entity ID

    • email string Required

      Recipient email address

    • firstname string | null Required

      Recipient first name

    • lastname string | null Required

      Recipient last name

    • expiresAt string(date-time) | null

      Expires at
POST /v1/families/{id}/invite 
curl \
 --request POST 'https://localhost/v1/families/fml_xxxxxxxx/invite' \
 --header "Content-Type: application/json" \
 --data '{"firstname":"Harry","lastname":"Potter","email":"h.potter@hogwarts.co.uk"}'
Request examples 
{
  "firstname": "Harry",
  "lastname": "Potter",
  "email": "h.potter@hogwarts.co.uk"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
{
  "id": "lnk_123123123123",
  "type": "staff_invitation",
  "companyId": "co_123123123123",
  "entityId": "stf_123123123",
  "email": "user@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "expiresAt": "2025-05-04T09:42:00Z"
}