Queued request ready template

notification Stable Latest stable

Queued request ready v1

queued-request-ready - v1

Subject: Your request is ready

Preheader: Your queued request has completed.

Required fields

Name	Type	Required	Description	Example
`actionButton.url`	url	Yes	Action Button URL Max 2048 characters	`https://example.com/app`

Optional fields

Name	Type	Required	Description	Example
`actionButton.label`	text	No	Action Button Label Max 120 characters	`View result`
`heading`	text	No	Heading Max 180 characters	`Your request is ready`
`intro`	text	No	Intro Max 1000 characters	`Your queued request has completed.`
`preheader`	text	No	Preheader Max 220 characters	`Your queued request has completed.`
`requestDetails`	detailsTable	No	Request details Details table keys: `requestedAt` (datetime), `completedAt` (datetime), `reference`	`{"requestedAt":"Requested At","completedAt":"Completed At","reference":"Reference"}`
`subject`	text	No	Subject Max 180 characters	`Your request is ready`

Defaults

{
  "actionButton.label": "View result",
  "heading": "Your request is ready",
  "intro": "Your queued request has completed.",
  "preheader": "Your queued request has completed.",
  "subject": "Your request is ready"
}

Example data

{
  "templateId": "queued-request-ready",
  "data": {
    "actionButton": {
      "url": "https://example.com/app"
    }
  }
}

Template messages

Type	Code	Message
Return	`accepted`	Valid template data can be queued by the send endpoint.
Error	`missing_required_variable`	Action Button URL is required.
Error	`field_too_long`	Action Button URL must be 2048 characters or fewer.
Error	`invalid_url`	Action Button URL must be a valid http or https URL.
Error	`field_too_long`	Action Button Label must be 120 characters or fewer.
Error	`field_too_long`	Heading must be 180 characters or fewer.
Error	`field_too_long`	Intro must be 1000 characters or fewer.
Error	`field_too_long`	Preheader must be 220 characters or fewer.
Error	`invalid_details_table`	Request details must be an object whose documented table keys are strings, numbers, or booleans.
Error	`field_too_long`	Subject must be 180 characters or fewer.