Guides

Name / Description	Type / Format	Example
`toName`	`string`	`"string"`
`toEmail`	`string`	`"string"`
`subject`	`string`	`"string"`
`buttonText`	`string`	`"string"`
`buttonLink`	`string`	`"string"`
`bodyPreview`	`string`	`"string"`
`body`	`string`	`"string"`
`afterBtnBody`	`string`	`"string"`
`status`	`string`	`"Queued"` `"Sent"` `"Failed"` `"Processing"`
`statusDate`	`string` date-time	`"2024-12-22T03:02:53"`
`statusMessage`	`string`	`"string"`
`sendAttempts`	`integer` int32	`0`
`webAppBaseUrl`	`string`	`"string"`
`attachments`	`EmailAttachment[]`	`{EmailAttachment}`
`id` The unique id of the object	`string` uuid	`"string"`

JSON Example

{
  "toName": "string",
  "toEmail": "string",
  "subject": "string",
  "buttonText": "string",
  "buttonLink": "string",
  "bodyPreview": "string",
  "body": "string",
  "afterBtnBody": "string",
  "status": "Queued",
  "statusDate": "2024-12-22T03:02:53",
  "statusMessage": "string",
  "sendAttempts": 0,
  "webAppBaseUrl": "string",
  "attachments": [
    {
      "url": "string",
      "filename": "string",
      "pdfPasswordType": "InitialsAndDob",
      "id": "string"
    }
  ],
  "id": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
Email Letter
Get Email
Re-send Email
Send Test Email
Send test email