Email Forms

Description: To email a form as an attachment a HTTP POST request is made to the URL with the agency ID, a unique download token and session token.

Method: POST

URI: /forms/form_id/email

URI Parameters

form_id: The ID of the form.

Parameters

instruction: Include the instruction page or not.
recipient: The email address of the recipient.
message: The message in the body of the email.

Headers: Authorization: Third party based authorization header

Returns

Field	Type	Description
Success	Boolean	The change was made successfully.
Message	String	Message relating to the update.

Example

Request

  curl https://app-api.reiformslive.com.au/forms/1/email \
  --request POST \
  --header "content-type: application/json" \
  --header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
  --data '{
              "instruction" : true,
              "recipient" : "johnd@example.com",
              "message" : "This is an example".
          }'

Response

  {
    "success": true,
    "message": "The email has been sent."
  }