Schedule Email

{
  "data": {
    "id": "string",
    "hostId": "string",
    "subject": "string",
    "body": "string",
    "sent": true,
    "recipient_emails": [
      "string"
    ],
    "recipient_phonenumbers": [
      "string"
    ],
    "event_refs": [
      "string"
    ],
    "timeslot_refs": [
      "string"
    ],
    "segment_refs": [
      "string"
    ],
    "date_sent": "2019-08-24T14:15:22Z",
    "footer_image": "string",
    "reply_to_email": "string",
    "automatic": true,
    "display_name": "string",
    "content_blocks": [
      null
    ],
    "viewport_data": null,
    "page_id": "string",
    "data_version": 0,
    "sync_event_recipients": true,
    "attachments": [
      {
        "name": "string",
        "size": 0,
        "url": "string",
        "type": "string",
        "uploading": true,
        "uploadError": "string",
        "storagePath": "string"
      }
    ],
    "sparkpost_metrics": {
      "count_sent": -9007199254740991,
      "count_delivered": -9007199254740991,
      "count_opens": -9007199254740991,
      "count_clicks": -9007199254740991,
      "count_bounce": -9007199254740991,
      "count_unsubscribe": -9007199254740991,
      "bounce_rate": "string",
      "open_rate": "string",
      "click_rate": "string",
      "revenue_generated": -9007199254740991,
      "fetched_at": 0
    },
    "activity_synced_at": 0,
    "createdAt": 0,
    "updatedAt": 0
  }
}

export interface Response {
  data: {
    id: string;
    /**
     * ID of the host workspace that owns this email.
     */
    hostId: string;
    /**
     * The email subject.
     */
    subject: string;
    /**
     * The rendered HTML body. Populated on send, empty on drafts.
     */
    body: string;
    /**
     * False for drafts; true once sent or scheduled.
     */
    sent: boolean;
    /**
     * Recipient email addresses. Note that if `sync_event_recipients` is true,
     * this will not include event attendees until send time.
     */
    recipient_emails: string[];
    /**
     * Unused.
     */
    recipient_phonenumbers: string[];
    /**
     * IDs of events whose attendees will be added to the recipients at send time.
     */
    event_refs: string[];
    /**
     * IDs of multi-day event timeslots whose attendees will be added to the
     * recipients at send time.
     */
    timeslot_refs?: string[];
    /**
     * IDs of segments whose members will be added to the recipients at send
     * time, with each member's segment columns available as smart values
     * (mail merge). The composer currently imports a single segment.
     */
    segment_refs?: string[];
    /**
     * When the email was sent or is scheduled to send, as an ISO string. Undefined for drafts.
     */
    date_sent?: string;
    /**
     * URL of the image shown in the email footer.
     */
    footer_image: string;
    /**
     * Reply-to address. Falls back to a system address when unset.
     */
    reply_to_email?: string;
    /**
     * Whether this email was generated by the automatic event-broadcast flow.
     */
    automatic?: boolean;
    /**
     * Sender label shown on the "From" line.
     */
    display_name?: string;
    /**
     * Deprecated legacy content. New emails use page_id instead.
     */
    content_blocks?: unknown[];
    /**
     * Deprecated embedded structured content. New emails use page_id instead.
     */
    viewport_data?: {
      [k: string]: unknown;
    };
    /**
     * ID of the Page this email renders.
     */
    page_id?: string;
    /**
     * Which content format this email uses. Assume `content_blocks` (0) when absent.
     */
    data_version?: 0 | 1 | 2;
    /**
     * If true, scheduled sends re-sync recipients from the linked events at send time.
     */
    sync_event_recipients: boolean;
    /**
     * File attachments included with the email.
     */
    attachments?: {
      /**
       * The original filename of the attachment.
       */
      name: string;
      /**
       * File size in bytes.
       */
      size: number;
      /**
       * Publicly fetchable URL.
       */
      url: string;
      /**
       * MIME type, e.g. `application/pdf`, `image/jpeg`.
       */
      type: string;
      uploading?: boolean;
      uploadError?: string;
      storagePath?: string;
    }[];
    /**
     * Delivery metrics and referral revenue for a sent email.
     */
    sparkpost_metrics?: {
      /**
       * Total messages sent.
       */
      count_sent: number;
      /**
       * Messages delivered to a recipient inbox (no bounce).
       */
      count_delivered: number;
      /**
       * Unique opens, counted by distinct recipient.
       */
      count_opens: number;
      /**
       * Unique clicks, counted by distinct recipient.
       */
      count_clicks: number;
      /**
       * Bounced messages (hard and soft).
       */
      count_bounce: number;
      /**
       * Recipients who unsubscribed.
       */
      count_unsubscribe: number;
      /**
       * Pre-formatted percentage, e.g. "2.3%"
       */
      bounce_rate: string;
      /**
       * Pre-formatted percentage, e.g. "10.0%"
       */
      open_rate: string;
      /**
       * Pre-formatted percentage, e.g. "1.5%"
       */
      click_rate: string;
      /**
       * Revenue attributed via referral tracking, minor units (cents)
       */
      revenue_generated?: number;
      /**
       * Epoch ms when these metrics were last fetched from Sparkpost
       */
      fetched_at?: number;
    };
    /**
     * Epoch ms when the activity feed was last synced from Sparkpost + orders.
     */
    activity_synced_at?: number;
    /**
     * Creation time, in epoch milliseconds.
     */
    createdAt: number;
    /**
     * Last-updated time, in epoch milliseconds.
     */
    updatedAt: number;
  };
}