Update Contact
PATCH {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/contacts/{{contactId}}
Description
This endpoint allows you to update an existing contact associated with a specific patient. By making a PATCH request to this endpoint, you can modify the information of a specific contact based on the provided patient ID and contact ID.
Parameters
The endpoint requires the following parameters:
{{url}}: The base URL of the API.{{tenantName}}: The name of the tenant or organization.{{instanceName}}: The name of the specific instance within the tenant.{{patientId}}: The unique identifier of the patient associated with the contact.{{contactId}}: The unique identifier of the contact you wish to update.
Request Headers
The following headers must be included in the request:
Authorization: A token or credentials to authenticate the request.Content-Type: The format of the request payload, typically set toapplication/json.
Request Body
The request body should contain the updated information for the contact. You can include any fields that need to be modified.
Response
The response to a successful request will include the updated contact object.
Error Handling
If an error occurs, the response will include an appropriate HTTP status code along with an error message or code to indicate the specific issue encountered. Common error codes include 400 for bad requests, 401 for unauthorized access, and 404 for not found.
Authorization
Proper authorization credentials must be provided in the request headers to access this endpoint. Consult the API documentation or contact the system administrator to obtain the necessary authorization details.
Request Body
{"name"=>"111", "emailLabel"=>"email label 1", "phoneLabel"=>"phone label 1", "phonePdtFieldName"=>"pdt-phone-field", "secondaryPhoneLabel"=>"sec phone label 1", "secondaryPhonePdtFieldName"=>"pdt-phone-field-1", "relation"=>"Husband 1", "active"=>false}