Transactional

List transactional emails

Changed on

Lists transactional email templates with their linked subjects and all-time delivery metrics. Search name, slug, or subject; filter active state; and sort by engagement. Human engagement is used by default.

get/transactional

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/transactional
  • Auth
    HTTP bearer

Query parameters

labelstring[]

Filter by company label names, matching any. Repeat the parameter for multiple names; commas are literal characters. Combined with search and status. Unknown names match no templates.

searchstring

Case-insensitive search across template name, API slug, and linked email subject/title.

status'all' | 'active' | 'disabled'

Filter by template active state.

sort'date' | 'sends' | 'opens' | 'open-rate' | 'clicks' | 'ctr'

Sort by creation date or all-time engagement metrics.

order'asc' | 'desc'

Sort direction.

includeMachineEngagementboolean

Include detected bot, scanner, preview, and privacy-proxy engagement in open and click metrics.

Response

Successful response

successboolean

Example response

{
  "success": true,
  "transactional": [
    {
      "labels": [
        "Billing",
        "Receipts"
      ],
      "id": "tx_abc123",
      "name": "Welcome Email",
      "slug": "welcome-email",
      "emailId": "email_123",
      "enabled": true,
      "managedBy": "dashboard",
      "emailPreset": "branded"
    }
  ]
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ////// to the response with the status

  • e93563b0d37eRevision changes
    • info

      added the new optional query request parameter label

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property ////// to the response with the status