Class Manager
POST /v1/auth/link-family

Links a Member (Family User) to a Company by creating a Family and Account

application/json

Body

Request body for linking a Family User to a company

  • firstname string Required

    firstname

  • lastname string Required

    lastname

  • phone string Required

    Phone number

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • userId string Required

      User ID

    • companyId string | null Required

      Company ID

    • entityId string | null Required

      Staff or Family ID that links this account to an entity

    • role string Required

      Values are staff, family, or admin.

    • permissionSet string Required

      Values are family, admin, owner, assistant, manager, instructor, or none.
POST /v1/auth/link-family 
curl \
 --request POST 'https://classmanager.test/v1/auth/link-family' \
 --header "Content-Type: application/json" \
 --data '{"firstname":"John","lastname":"Doe","phone":"+13124567890"}'
Request examples 
{
  "firstname": "John",
  "lastname": "Doe",
  "phone": "+13124567890"
}
Response examples (200) 
{
  "id": "co_123123123123",
  "userId": "usr_123123123123",
  "companyId": "co_123123123123",
  "entityId": "stf_123123123123",
  "role": "staff",
  "permissionSet": "family"
}