Skip to content

Campaigns API

Schedule a campaign message

POSThttps://email.growthdept.ai/api/campaign-message-schedule

static, local_timezone and throttled need send_time; smart_send_time needs send_date. The message must be a draft.

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

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

Query parameters

array of strings

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

    • attributesobjectrequired

      attributes: 5 fields
      • send_timestring

      • send_datestring

      • strategystringrequired

        local_timezonesmart_send_timestaticthrottled
      • throttled_optionsobject

        throttled_options: 2 fields
        • throttling_percentageintegerrequired

        • throttle_unitstring

      • timezone_optionsobject

        timezone_options: 1 field
        • send_past_timezones_tomorrowbooleancan be null

    • 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-message-schedule
    • idstringrequired

    • attributesobjectrequired

      attributes: 5 fields
      • send_timestring (date-time)can be null

      • send_datestring (date)can be null

      • strategystringrequired

        local_timezonesmart_send_timestaticthrottled
      • throttling_percentageintegercan be null

      • throttle_unitstringcan be null

        hourminute
    • relationshipsobject

      relationships: 1 field
      • campaign-messageobject

        campaign-message: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign-message
          • 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