Templates

Get template

Changed on

Returns one email template. Transactional email IDs and slugs are also resolved for compatibility, as is the emailId returned by campaign endpoints, so this can read the blocks of an email designed in the dashboard.

get/templates/{templateId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/templates/{templateId}
  • Auth
    HTTP bearer

Path parameters

templateIdstring required

Template ID, transactional email ID, or transactional slug.

Response

Template returned

successboolean
transactionalobject nullable

Example response

{
  "success": true,
  "template": {
    "id": "email_abc123",
    "name": "[Template] Welcome",
    "subject": "Welcome!",
    "emailPreset": "branded",
    "labels": [
      "edm",
      "template"
    ],
    "companyId": "company_abc123",
    "blocks": [
      {
        "id": "block_123",
        "type": "html",
        "content": "<h1>Hello</h1>",
        "styles": {
          "backgroundColor": "#f8fafc",
          "backgroundOpacity": 80,
          "textColor": "#111827",
          "borderRadius": 12,
          "borderColor": "#cbd5e1",
          "borderWidth": 1
        },
        "conditions": [
          {
            "id": "c1",
            "value": "plan:pro"
          }
        ]
      }
    ],
    "abTests": [
      {
        "contentEditing": {
          "readTool": "get_ab_test",
          "writeTool": "update_ab_test_variant",
          "requiredScopes": [
            "ab_tests:read",
            "ab_tests:write",
            "sequences:write"
          ]
        }
      }
    ]
  }
}

Changes

  • e2e7d27d7804Revision changes
    • info

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

  • 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