Discussion

Given a facility_id and event_id, this endpoint will attempt to deliver any of the event's esignable documents to the specified email address or phone number (via sms).
If there are no esignable documents related to the specified event, a 400 status code will be returned along with an error message.
You should never specify both email and sms_number. If both parameters are provided, an error will be returned.

Params

Param name Description
email
optional

Required to send esignable documents via email

Validations:

  • Must be a String

sms_number
optional

Required to send esignable documents via sms

Validations:

  • Must be a String

Examples

POST /v1/b313fc0b-1073-4650-8815-ef015c41b553/documents/0f3879e5-2d55-40aa-8108-3a01e2a4d3d8/send_esignable_documents
{
  "email": "[email protected]",
  "document": {
    "email": "[email protected]"
  }
}
200
{
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "email": "[email protected]",
      "facility_id": "b313fc0b-1073-4650-8815-ef015c41b553",
      "event_id": "0f3879e5-2d55-40aa-8108-3a01e2a4d3d8",
      "document": {
        "email": "[email protected]"
      }
    }
  }
}