Class Manager
POST /v1/families/{id}

Update Family

Path parameters

  • id string Required

    family id

application/json

Body

Request for updating an existing Family

  • firstname string Required

    First name of the Primary Contact of the Family

  • lastname string Required

    Last name of the Primary Contact of the Family. Also the family name

  • email string Required

    Email address of the Primary Contact of the Family

  • phone string

    Phone number of the Primary Contact of the Family

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • name string Required

      Name

    • joinedAt string(date) | null Required

      Joined at date

    • invitationStatus string Required

      Values are not_invited, invited, or accepted.

    • autopayEnabled boolean Required

      Flag to indicate whether automated payments will be taken for the family

    • profilePicture string | null Required

      Profile Picture

    • deletedAt string(date-time) | null Required

      Deleted at date

    • archivedAt string(date-time) | null Required

      Archived at date

    • createdAt string(date-time) Required

      Created at date
  • 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
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/families/{id} 
curl \
 --request POST 'https://localhost/v1/families/fml_123123123123' \
 --header "Content-Type: application/json" \
 --data '{"firstname":"Harry","lastname":"Potter","email":"h.potter@hogwarts.co.uk","phone":"01234567890"}'
Request examples 
{
  "firstname": "Harry",
  "lastname": "Potter",
  "email": "h.potter@hogwarts.co.uk",
  "phone": "01234567890"
}
Response examples (200) 
{
  "id": "fml_123123123123",
  "companyId": "co_123123123123",
  "name": "Potter",
  "joinedAt": "2023-12-05",
  "invitationStatus": "not_invited",
  "autopayEnabled": true,
  "profilePicture": "https://",
  "deletedAt": "2023-12-05 14:30:41",
  "archivedAt": "2023-12-05 14:30:41",
  "createdAt": "2023-12-05 14:30:41"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}