Customer.io
v1.0.0
OpenAPI 3.1.0

Schedule a one-time send

US region

Client Libraries
Shell Curl

Schedule a one-time send

​

Schedule a one-time send (referred to as a "newsletter" in our APIs) to send at a specific time. It must be in a draft state. If it has already been sent, you'll get a 400 error. If it's already scheduled, this endpoint updates the scheduled time.

The response returns the one-time send, so you can read back the schedule you set: send_state and scheduled_at are always included, and timezone and tz_match_enabled are included when they apply.

To retrieve the schedule parameters after scheduling with Get a one-time send. After you start a send with timezone-match, scheduled_at reports the next timezone batch or the remainder of an A/B test instead of the time you requested.

The recipients are fixed when you create the one-time send. If you're not sure who will receive it, you can use the List one-time sends endpoint to get a list of one-time sends and their recipients.

Path Parameters
  • newsletter_id
    Type: integer
    required

    The identifier of a one-time send.

Body
required
application/json

Only scheduled_at is required. If you want to send with a rate limit, set both rate_limit_email_rate or rate_limit_time_period. rate_limit_spread can be set alone.

  • Type: object

    Only scheduled_at is required. If you want to send with a rate limit, set both rate_limit_email_rate or rate_limit_time_period. rate_limit_spread can be set alone.

Responses
  • application/json
  • application/json
  • 404

    The one-time send does not exist.

  • application/json
  • application/json
Request Example for post/v1/newsletters/{newsletter_id}/schedule
{
  "scheduled_at": 1719849600,
  "rate_limit_email_rate": 500,
  "rate_limit_spread": true,
  "rate_limit_time_period": 60,
  "timezone": "America/New_York",
  "tz_match_enabled": false
}

{
  "newsletter": {
    "content_ids": [
      45
    ],
    "created": 1481653919,
    "deduplicate_id": "128275:1481653929",
    "id": 128275,
    "name": "Weekly Product Update",
    "recipient_segment_ids": [
      42,
      99
    ],
    "scheduled_at": 1719849600,
    "send_state": "scheduled",
    "sent_at": null,
    "subscription_topic_id": 5,
    "timezone": "America/New_York",
    "type": "email",
    "updated": 1481653929
  }
}

The one-time send is scheduled for sending.