Skip to content

Resend Survey Invitation

This endpoint will resend an invitation to a patient for a given survey

Request

POST /accounts/{account-uuid}/surveys/{survey-uid}/invitations
  • account-uuid is a 22-character identifier for the account
  • survey-uuid is a 22-character identifier for the survey

Authorization

Authorization is required. Since this endpoint will be used from the Dashboard, nothing is needed from dashboard code, since the auth cookie is handled by the API

Headers

N/A

Query Parameters

N/A

Response

Response Status Code More Information
Success 201 If the response is successful
Unauthorized 401 If user is not authorized for the requested account/survey
Bad Request 400 If the invitation cannot be sent
Internal Server Error 500 Unknown error

400 - Bad Request

if a 400 is received, it can be for one of a few reasons. A code and description will be returned. Here are the code/reason responses that could be returned.

Code Description
1 Too many invitation requests too quickly
2 Survey invitations not allowed

Headers

N/A