Invite Patient

using RestSharp;
var client = new RestClient("https://api.ferry.health/api/v1/patient-invitations/invite");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"phoneNumber\": \"+12234567890\",\n  \"seedData\": {\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Smith\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

{
  "type": "PENDING",
  "invitationId": "ferry.patient-invitation.84396f99-a7d1-44f9-ae8b-01741931269e",
  "pendingTasks": [],
  "phoneNumber": "+12234567890",
  "seedData": {
    "firstName": "Jane",
    "lastName": "Smith"
  }
}

If an open invitation already exists for this phone number, we will update the invitation’s seed data with the provided information.

If a patient with the phone number has already enrolled, this endpoint is a no-op. We will not update the existing patient in any way.

Invite a patient to enroll in Ferry. When an invitation is created, we will text the patient with a link to sign up for an account in Ferry. You may optionally provide seed data (e.g. patient name, gender, date of birth, etc.) to pre-populate the patient's profile. If an open invitation already exists for this phone number, we will update the invitation's seed data with the provided information. If a patient with the phone number has already enrolled, this endpoint is a no-op. We will **not** update the existing patient in any way.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

phoneNumberstringRequired

The phone number of the patient. This can be in any reasonable format.

seedDataobjectOptional

Seed data that will be used to pre-populate the patient’s profile.

Response

This endpoint returns an object.

PENDINGobject

ENROLLEDobject