Skip to content

Campaigns API

Give a campaign message its own copy of a template

POSThttps://email.growthdept.ai/api/campaign-message-assign-template

The request body can be up to 5 MB.

Rate limits

Burst: 10/s

Steady: 150/m

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

Scopes

campaigns:write

Operation id

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

Query parameters

array of strings

Attributes of campaign-message 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

      campaign-message
    • idstringrequired

    • relationshipsobjectrequired

      relationships: 1 field
      • templateobjectrequired

        template: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            template
          • 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

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      campaign-message
    • idstringrequired

    • attributesobjectrequired

      attributes: 7 fields
      • labelstringrequired

      • channelstringrequired

      • contentone ofrequired

        One option: EmailContentSubObject
        • subjectstringcan be null

        • preview_textstringcan be null

        • from_emailstringcan be null

        • from_labelstringcan be null

        • reply_to_emailstringcan be null

        • cc_emailstringcan be null

        • bcc_emailstringcan be null

        One option: SMSContentSubObject
        • bodystringcan be null

        • media_urlstringcan be null

      • send_timesarray of objectscan be null

        send_times: 2 fields
        • datetimestring (date-time)required

        • is_localbooleanrequired

      • render_optionsobjectcan be null

        render_options: 4 fields
        • shorten_linksbooleancan be null

        • add_org_prefixbooleancan be null

        • add_info_linkbooleancan be null

        • add_opt_out_languagebooleancan be null

      • created_atstring (date-time)can be null

      • updated_atstring (date-time)can be null

    • relationshipsobject

      relationships: 2 fields
      • campaignobject

        campaign: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • templateobject

        template: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            template
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

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