Skip to content

Campaigns API

Add a variation to a campaign message

POSThttps://email.growthdept.ai/api/campaign-variations

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

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

Query parameters

array of strings

Attributes of campaign-variation 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: 5 fields
    • typestringrequired

      campaign-variation
    • idstring

    • attributesobjectrequired

      attributes: 1 field
      • definitionobjectrequired

        definition: 2 fields
        • namestring

        • detailsobject

    • relationshipsobject

      relationships: 1 field
      • campaign-messageobjectrequired

        campaign-message: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            campaign-message
          • idstringrequired

    • metaobject

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

201Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      campaign-variation
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • createdstring (date-time)required

      • updatedstring (date-time)required

      • definitionobjectrequired

        definition: 2 fields
        • namestringcan be null

        • detailsone ofcan be null

          One option: EmailChannelDetails
          • channelstring

            email
          • template_idstringcan be null

          • from_labelstring

          • from_emailstring

          • reply_to_emailstring

          • cc_emailstring

          • bcc_emailstring

          • subjectstring

          • preview_textstring

          One option: SMSChannelDetails
          • channelstring

            sms
          • template_idstringcan be null

          • costnumbercan be null

          • mms_static_image_asset_idintegercan be null

          • shorten_linksbooleancan be null

          • include_contact_cardbooleancan be null

          • bodystring

          • add_org_prefixbooleancan be null

          • add_info_linkbooleancan be null

          • add_opt_out_languagebooleancan be null

          • mms_dynamic_image_templatestringcan be null

          • text_message_typestring

            MMSRCSSMS
          • message_hierarchyarray of objectscan be null

            One option: MessageHierarchyRcsItem
            • messagestring

            • message_formatstring

              RCS
            • rich_contentobjectcan be null

              rich_content: 3 fields
              • cardsarray of objectscan be null

              • suggestionsarray of objectscan be null

              • fileobjectcan be null

            • extraobjectcan be null

            • imageobjectcan be null

              image: 3 fields
              • static_image_asset_idintegercan be null

              • dynamic_image_templatestringcan be null

              • rendered_asset_urlstringcan be null

            One option: MessageHierarchySmsItem
            • messagestringrequired

            • message_formatstring

              SMS
            • extraobjectcan be null

            • imageone ofcan be null

              One option: StaticSMSImage
              • dynamicbooleancan be null

                false
              • static_image_asset_idintegerrequired

              One option: DynamicSMSImage
              • dynamicboolean

                true
              • dynamic_image_templatestringrequired

            • mediaone ofcan be null

              One option: MediaAsset
              • idstringrequired

              • company_idstringrequired

              • urlstringrequired

              • media_typestring

              • namestringrequired

              • file_sizeintegerrequired

              • thumbnail_urlstringcan be null

              • l10n_keystringcan be null

              One option: MediaAssetReference
              • static_asset_idstringcan be null

              • dynamic_templatestringcan be null

              • thumbnailobjectcan be null

          One option: PushChannelDetails
          • channelstring

            push
          • titlestring

          • bodystring

          • badgeboolean

          • badge_configstring

            increment-oneset-countset-property
          • badge_valuestring

          • sound_file_namestring

          • static_asset_idintegercan be null

          • soundboolean

          • open_actioninteger

          • dynamic_media_templatestring

          • kv_pairsobjectcan be null

          • push_typestring

            silentstandard
          • ios_deep_linkstringcan be null

          • android_deep_linkstringcan be null

          • web_urlstringcan be null

          • content_availablebooleancan be null

          • send_to_inboxbooleancan be null

          • mutable_contentbooleancan be null

          • video_asset_idstringcan be null

          • action_buttonsarray of objectscan be null

            action_buttons: 7 fields
            • labelstringrequired

            • action_typestringrequired

              deep_linkdismissopen_appopen_url
            • urlstringcan be null

            • iconstringcan be null

            • custom_action_idstringcan be null

            • ios_deep_linkstringcan be null

            • android_deep_linkstringcan be null

          • push_platform_targetintegercan be null

          • send_to_primarybooleancan be null

          One option: WhatsappChannelDetails
          • channelstring

            whatsapp
          • template_idstringcan be null

          • shorten_linksboolean

    • relationshipsobject

      relationships: 3 fields
      • campaign-messageobject

        campaign-message: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • translationobject

        translation: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            translation
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • imageobject

        image: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

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