diff --git a/api/external/mailings.html b/api/external/mailings.html index 09afcef..f63d201 100644 --- a/api/external/mailings.html +++ b/api/external/mailings.html @@ -282,110 +282,6 @@

Mailings -
-GET /#account_id/calendar
-

Get information about sent and scheduled mailings for the calendar.

- --- - - - - - - - -
Parameters:
    -
  • start_date (string) – Include sent or scheduled mailings starting on this date
  • -
  • end_date (string) – Include sent or scheduled mailings up to this end date
  • -
  • with_html_body (boolean) – Optional flag to include the html_body content.
  • -
  • with_plaintext (boolean) – Optional flag to include the plaintext content.
  • -
-
Raises :

Http400 if the start and end dates are invalid or missing.

-
Returns :

An array of mailings.

-
-

-

-Sample Response -[showhide] -
-GET /100/calendar?start_date=2018-09-16&end_date=2018-09-17
-
-[
-  {
-    "mailing_type": "m",
-    "send_started": "@D:2018-09-16T10:30:10",
-    "cancel_by_user_id": null,
-    "mailing_id": 210,
-    "recipient_count": 1,
-    "cancel_ts": null,
-    "mailing_status": "c",
-    "account_id": 100,
-    "month": 9,
-    "failure_ts": null,
-    "reply_to": null,
-    "year": 2018,
-    "deleted_at": null,
-    "started_or_finished": "@D:2018-09-16T10:30:10",
-    "subject": "Sample Mailing for [% member:first_name %] [% member:last_name %]",
-    "disabled": false,
-    "created_ts": "@D:2018-09-13T10:18:34",
-    "sender": "Kevin McConnell",
-    "plaintext_only": false,
-    "name": "Sample Mailing",
-    "hour": 10,
-    "parent_mailing_id": null,
-    "failure_message": null,
-    "day": 16,
-    "send_finished": "@D:2018-09-16T10:30:16",
-    "datacenter": null,
-    "send_at": "@D:2018-09-16T10:30:00",
-    "signup_form_id": null,
-    "purged_at: null,
-    archived_ts: null
-  },
-  {
-    "mailing_type": "m",
-    "send_started": null,
-    "cancel_by_user_id": null,
-    "mailing_id": 211,
-    "recipient_count": 0,
-    "cancel_ts": null,
-    "mailing_status": "p",
-    "account_id": 100,
-    "month": null,
-    "failure_ts": null,
-    "reply_to": null,
-    "year": null,
-    "deleted_at": null,
-    "started_or_finished": null,
-    "subject": "Scheduled Mailing",
-    "disabled": false,
-    "created_ts": "@D:2018-09-13T10:16:54",
-    "sender": "Donna Smith",
-    "plaintext_only": false,
-    "name": "Scheduled Mailing",
-    "hour": null,
-    "parent_mailing_id": null,
-    "failure_message": null,
-    "day": null,
-    "send_finished": null,
-    "datacenter": null,
-    "send_at": "@D:2018-09-22T10:30:00",
-    "signup_form_id": null,
-    "purged_at": null,
-    "archived_ts": null
-  }
-]
-
-
-
-

-
- -
GET /#account_id/mailings/#mailing_id