newsletterObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/customer-io/main/json-schema/customer-io-newsletter-object-schema.json",
  "title": "newsletterObject",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/customer-io-journeys-api-openapi.yml#/components/schemas/newsletterObject",
  "x-scalar-ignore": true,
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/newsletter_id"
    },
    "deduplicate_id": {
      "$ref": "#/$defs/deduplicate_id"
    },
    "content_ids": {
      "type": "array",
      "description": "A list of message variants in a one-time send, where a variant is a translation or A/B test.",
      "items": {
        "type": "integer"
      }
    },
    "name": {
      "type": "string",
      "description": "The name of the one-time send. Must be 190 characters or less.",
      "readOnly": true
    },
    "sent_at": {
      "type": [
        "integer",
        "null"
      ],
      "format": "unix timestamp",
      "description": "The last time the one-time send was sent, or `null` if it hasn't been sent."
    },
    "send_state": {
      "type": "string",
      "readOnly": true,
      "description": "Where the one-time send is in its lifecycle. Always included. This matches the status shown in Customer.io, with one exception noted under `awaiting_winner`.\n\n- `drafted`: The one-time send isn't scheduled and hasn't been sent.\n- `scheduled`: A send time is set and sending hasn't started.\n- `sending`: Sending has started and is still in progress. More batches are due (timezone-match batches or the remainder of an A/B test), or messages are still being delivered.\n- `sent`: The one-time send is no longer sending. This doesn't mean that every individual message has reached a final state.\n- `paused`: The one-time send is paused.\n- `stopped`: The one-time send was stopped.\n- `failed`: The one-time send failed.\n- `awaiting_winner`: An A/B test has started and is waiting for you to pick a winner before the rest of the audience gets it. Test messages might still be going out. Customer.io's UI stops showing \"awaiting winner\" 30 days after the first send, but the API keeps reporting `awaiting_winner` because you can still pick a winner.\n\nWhen more than one state applies, Customer.io reports the first match in this order: `stopped`, `failed`, `paused`, `awaiting_winner`, `sending`, `sent`, `scheduled`, `drafted`.\n",
      "enum": [
        "drafted",
        "scheduled",
        "sending",
        "sent",
        "paused",
        "stopped",
        "failed",
        "awaiting_winner"
      ]
    },
    "scheduled_at": {
      "type": [
        "integer",
        "null"
      ],
      "format": "unix timestamp",
      "readOnly": true,
      "description": "When the one-time send is scheduled to go out, or `null` if it has no active schedule. Always included.\n\n- A paused one-time send keeps its schedule, so this still has a value while `send_state` is `paused`.\n- After sending starts, this stores the next scheduled send if there is one, like the next timezone batch or the remainder of an A/B test.\n- When `tz_match_enabled` is `true`, the `scheduled_at` property is the time you asked for in the [schedule request](/integrations/api/app/tag/send-messages/scheduleNewsletter/) until sending starts.\n- If you send immediately instead of scheduling, there's a short delay before Customer.io starts sending. During that delay, `scheduled_at` isn't `null` and isn't a future time: it's the time you made the request, an earlier time, or `0`.\n"
    },
    "timezone": {
      "type": "string",
      "readOnly": true,
      "description": "The [IANA timezone name](/journeys/send/timezones/example-timezones/#region-format) of the schedule (for example, `America/New_York`). Customer.io includes this field only when the active schedule has a timezone. It's omitted otherwise.\n"
    },
    "tz_match_enabled": {
      "type": "boolean",
      "readOnly": true,
      "description": "`true` when the pending schedule sends at the same local time in each person's timezone. Customer.io includes this field only while a timezone-match schedule is pending. It's omitted otherwise and is never `false`.\n"
    },
    "created": {
      "$ref": "#/$defs/created"
    },
    "updated": {
      "$ref": "#/$defs/updated"
    },
    "type": {
      "$ref": "#/$defs/newsletterMessageType"
    },
    "tags": {
      "type": "array",
      "description": "An array of tags associated with the one-time send.",
      "items": {
        "type": "string"
      }
    },
    "recipient_segment_ids": {
      "description": "If the recipient conditions included segments, this returns a list of those segment ids.",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "subscription_topic_id": {
      "type": "integer",
      "description": "If you enabled a [subscription center](/journeys/channels/subscriptions/center/) on your workspace, this returns the id of the subscription preference you set."
    },
    "expires_after": {
      "type": "integer",
      "description": "The send window in seconds, if you set one. Customer.io stops delivering the one-time send this long after it starts."
    },
    "recipient_file_status": {
      "type": "string",
      "description": "How far Customer.io has got with a recipient file, whether you uploaded it in the UI or passed `recipient_file_url`. Customer.io omits this field when the audience came from a `recipients` filter. Wait for `done` before you send or schedule.\n",
      "enum": [
        "pending",
        "processing",
        "done",
        "error"
      ]
    },
    "recipient_file_error": {
      "type": "string",
      "description": "Why the recipient file failed, when `recipient_file_status` is `error`. Customer.io omits it otherwise."
    }
  },
  "$defs": {
    "created": {
      "x-scalar-ignore": true,
      "type": "integer",
      "format": "unix timestamp",
      "description": "The date time when the referenced ID was created.",
      "readOnly": true
    },
    "deduplicate_id": {
      "x-scalar-ignore": true,
      "type": "string",
      "readOnly": true,
      "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, One-time sends, Segments, and Templates), and the timestamp is the last time the object was updated."
    },
    "newsletterMessageType": {
      "x-scalar-ignore": true,
      "description": "Channel type for a one-time send or one-time send content variant.",
      "type": "string",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "push",
        "in_app",
        "inbox"
      ],
      "readOnly": true
    },
    "newsletter_id": {
      "x-scalar-ignore": true,
      "description": "The identifier for a one-time send.",
      "type": "integer"
    },
    "updated": {
      "x-scalar-ignore": true,
      "type": "integer",
      "format": "unix timestamp",
      "description": "The date time when the referenced ID was last updated.",
      "readOnly": true
    }
  }
}