Add a User Contact

post/public/v1/users/{user}/contacts

Adds an emergency contact or next of kin to a user. A person who is both is added twice, once per role. A user can have up to 10 contacts.

post/public/v1/users/{user}/contacts

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/users/{user}/contacts' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "relationship": "string",
  "phone": "string",
  "email": "jane.citizen@example.com",
  "role": "emergency_contact"
}'

Response

{
  "data": {
    "id": "c1o2n3t4-a5c6-47t8-9a0b-1c2d3e4f5a6b",
    "name": "Margaret Doe",
    "relationship": "Mother",
    "phone": "0412345678",
    "email": "margaret.doe@example.com",
    "role": "emergency_contact"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

userstringrequired
The user UUID

Body

application/json

namestringrequiredmax length 255
relationshipstringrequiredmax length 255
phonestring | nullmax length 255
emailstring<email> | nullmax length 255
roleenum<string>required
Available options:emergency_contactnext_of_kin

Response

200application/json

UserContactResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:c1o2n3t4-a5c6-47t8-9a0b-1c2d3e4f5a6b
- namestringrequired
  Example:Margaret Doe
- relationshipstring | nullrequired
  Example:Mother
- phonestring | nullrequired
  Example:0412345678
- emailstring | nullrequired
  Example:margaret.doe@example.com
- roleenum<string>required
  Available options:emergency_contactnext_of_kin

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error