updatePatients

Update patients in a project. Only data requestors can use this endpoint to update patients in projects they have access to.

Path Parameters
projectId string — REQUIRED Project Id

Request Body — REQUIRED

patients object[] — REQUIRED Array of patients to update in the project referenceId string — REQUIRED Reference ID of the patient to update firstName string First name of the patient lastName string Last name of the patient externalId string External ID of the patient email string Email of the patient phone string Phone number of the patient contactPreference string Possible values: [email, phone] Contact preference of the patient languagePreference string Possible values: [en, es] Language preference of the patient targetedFacilities array[] Targeted facilities of the patient allowOnlyTargetedFacilities boolean Exclude untargeted facilities of the patient

Responses

200 Results of updating patients including success count and errors Schema — OPTIONAL totalProcessed number Total number of patients processed in the request successCount number Number of patients successfully updated errorCount number Number of patients that failed to be updated due to validation errors errors object[] — OPTIONAL Array of errors that occurred during patient processing patientIndex number Index of the patient in the original request array that caused the error error string Description of the error that occurred while processing this patient