List Schedules

Returns an array of all scheduled messages.

Scheduled Message

  • id = the id of the scheduled message.
  • tenantid - the id of the tenant the scheduled message belongs to.
  • campaignId - the id of the campaign the scheduled message belongs to.
  • contactMethod - the type of message.
  • messageId - the id of the message getting sent.
  • segments - array of segment ids to sent to.
  • excludes - array of segment ids to exclude.
  • dateScheduled - the localized to the tenant date and time when the message is sent.
  • send_window_hours - distribute the send evenly across a number of hours.
  • limit_recipients - only send to a limited number of recipients.
  • status - what is the status of this scheduled message.
Click Try It! to start a request and see the response here!