Docy

POST /sendemail

Use this endpoint to send a confirmation email for an existing visitor registration. Since a complete (registered) visitor registration is always associated with a registration form, the email which is sent is as configured within that form, including any applicable email sending rules.

JSON body

{
  "visitorID": "[your visitor ID]",
  "type": "confirmation",
  "force": true
}

visitorID: the alphanumeric id of an existing visitor registration

type: currently the only supported value is confirmation. This parameter has been included to permit future functionality.

force: true/false. Visit keeps a log of emails delivered successfully to visitors. Set force to ‘false’ to prevent the email from being sent repeatedly in the case that the recipient has already received the configured email template. Setting force to ‘true’ will cause the email to be sent regardless. It’s possible to view the email receipt history for a visitor by opening their account in visit’s Service Centre.

JSON response

{
    "force": false,
    "sent": true,
    "type": "confirmation",
    "visitorID": "[your visitor ID]"
}

visitorID: the alphanumeric id of an existing visitor registration

type: reflects this property from the request

force: reflects this property from the request

sent: true/false, email sent status

CONTENTS