POST/transactional-api/update-patient-email-address

Update Patient Email Address

Sets the patient's email address of the given type, removing any existing address of that type first. User-restricted only.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/update-patient-email-address' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "patientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "emailAddress": "patient@example.com",
    "emailAddressType": "personal",
    "preferredEmailAddress": false
  }'

Body parameters

Field	Type	Required	Description
patientId	string<uuid>	Yes	Medicus patient identifier.
emailAddress	string<email>	Yes
emailAddressType	enum	Yes	Which of the patient's email addresses to set. One of: personal, work.
preferredEmailAddress	boolean	No	Whether this becomes the patient's preferred email address. Unsets the flag on any other address.

Responses

200 Email address updated.

Response fields

Field	Type	Description
status	string

{
  "status": "ok"
}

400 Validation error.

5 possible code values

Code	Description	When
missing-patient-id	The patientId is required	patientId missing
invalid-patient-id	The patientId is not valid	patientId not a valid UUID
invalid-email-address	The emailAddress is not valid	emailAddress missing or not a valid email address
invalid-email-address-type	The emailAddressType must be one of: personal, work	emailAddressType missing or not one of personal/work
patient-not-found	Patient not found for this patientId	patientId doesn't exist

Response fields

Field	Type	Description
errors[].code	string
errors[].description	string

{
  "errors": [
    {
      "code": "missing-patient-id",
      "description": "The patientId is required"
    }
  ]
}

403 The call is application-restricted rather than user-restricted.

Response fields

Field	Type	Description
errors[].code	string
errors[].description	string

{
  "errors": [
    {
      "code": "application-restricted-not-supported",
      "description": "This endpoint is only available to user-restricted callers."
    }
  ]
}