Send a communication to the patient

patch

https://customer-api-sandbox.greenlighthealth.com/v1/customers/{customerId}/orders/{orderId}/notify

Sends a communication to the patient, this will be scheduled for later if the communication is outside business hours for the patients timezone. This communication must be configured per customer before use, as no default is provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Empty response

400The malformed input error. Indicates that the server does not understand this request. Field invalidFields contains the field name and the error description.

401The unauthorized error. Indicates the client is unauthorized to perform this action. Check to ensure your x-api-key is correct and the token is still valid.

404The not found error. Indicates the requested entity was not found

422The invalid input error. Indicates the server could decode the request but the request was semantically invalid. Field invalidFields contains the fieldname and the error description.

429The TooManyRequests error. Indicates the rate limit was hit for this call or customer. Implement an incremental backoff to avoid this error.

500The internal server error. An unexpected error condition occurred, contact support if the issue persists. Include the returned requestId when contacting support.