Dashboard
Edit Article Logout

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.

HTTP Response Examples
200
{ "Status": true, "Message": "", "Response": { "schedule": [ { "id": 41911, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 49480, "segments": [ 13142 ], "excludes": [], "dateScheduled": "2023-09-25T15:30:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 42032, "tenantid": 12, "campaignId": 8638, "contactMethod": "SendEmail", "messageId": 48106, "segments": [], "excludes": [], "dateScheduled": "2023-09-30T13:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 42539, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 50942, "segments": [], "excludes": [], "dateScheduled": "2023-10-17T16:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 42646, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 50943, "segments": [ 13427 ], "excludes": [], "dateScheduled": "2023-10-20T16:30:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 42831, "tenantid": 12, "campaignId": 8638, "contactMethod": "SendEmail", "messageId": 50808, "segments": [], "excludes": [], "dateScheduled": "2023-10-25T10:30:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 44011, "tenantid": 12, "campaignId": 8638, "contactMethod": "SendEmail", "messageId": 51146, "segments": [], "excludes": [], "dateScheduled": "2023-11-28T10:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 44250, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 53288, "segments": [], "excludes": [], "dateScheduled": "2023-12-06T10:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 44251, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 53301, "segments": [], "excludes": [], "dateScheduled": "2023-12-12T10:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" }, { "id": 44542, "tenantid": 12, "campaignId": 5196, "contactMethod": "SendEmail", "messageId": 53289, "segments": [ 14118, 2684 ], "excludes": [], "dateScheduled": "2023-12-14T11:00:00", "send_window_hours": null, "limit_recipients": null, "status": "Ended" } ] } }


How helpful was this article?

πŸ‘ or πŸ‘Ž

Related Articles