Create a Family

Creates a family by passing the required family information.
Family
Create a Family
 last updated: 
March 31, 2022

END POINT

  1. POST /v1/family

REQUEST

  1. {
  2.     "name": "Doe Family",
  3.     "phone": "+14815220744",
  4.     "email": "john@doefam.com",
  5.     "address": {
  6.         "addressType": "mailing",
  7.         "line1": "1 Broadway",
  8.         "line2": "",
  9.         "city": "Los Gatos",
  10.         "state": "CA",
  11.         "country": "US",
  12.         "postalCode": "00603"
  13.     }
  14. }

RESPONSE

  1. {
  2.     "id": "fam-6988065d-5a54-4d0c-b83b-d3190a93e52e",
  3.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  4.     "createdPersonId": "per-d0309a56-a71f-449b-8d1b-105f926dcfc0",
  5.     "status": "active",
  6.     "name": "Doe Family",
  7.     "email": "john@doefam.com",
  8.     "phone": "+14815220744",
  9.     "address": {
  10.         "addressType": "mailing",
  11.         "line1": "1 Broadway",
  12.         "line2": "",
  13.         "city": "Los Gatos",
  14.         "state": "CA",
  15.         "country": "US",
  16.         "postalCode": "95030"
  17.     },
  18.     "createdAt": "2022-03-31T21:01:35Z",
  19.     "modifiedAt": "2022-03-31T21:01:35Z",
  20.     "metadata": null
  21. }