Skip to content

Templates API

Send a test of a template

POSThttps://email.growthdept.ai/api/template-preview-send-jobs

Renders the template with the context (or the related profile, or a sample person) and queues a test to each address. Addresses must be the organization's people or confirmed test recipients; if none qualifies the request is refused.

The request body can be up to 5 MB.

Rate limits

Burst: 1/s

Steady: 15/m

Daily: 100/day

Tier XS. See rate limits for how requests are counted.

Scopes

templates:write

Operation id

create_template_preview_send_job The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of template-preview-send-job resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      template-preview-send-job
    • attributesobjectrequired

      attributes: 2 fields
      • recipientsarray of stringsrequired

      • contextobject

    • relationshipsobjectrequired

      relationships: 2 fields
      • templateobjectrequired

        template: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            template
          • idstringrequired

      • profileobject

        profile: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

202Success

No body.

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject