{ "opencollection": "1.0.0", "info": { "name": "AppConnect V3 Account Services Email Scheduling API", "version": "3.0.149" }, "items": [ { "info": { "name": "Email Scheduling", "type": "folder" }, "items": [ { "info": { "name": "GET an Email Campaign Activity Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/schedules", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity." } ] }, "docs": "Use this method to return the current schedule for an email campaign activity. This schedule contains the date that Constant Contact will send the email campaign activity to contacts. If the email campaign activity is not in `SCHEDULED` status, this method returns an empty array and a 200 response code." }, { "info": { "name": "POST (Create) an Email Campaign Activity Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/schedules", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity. You can only schedule email campaign activities that have the `primary_email` role." } ] }, "docs": "Use this method to send an email campaign activity to contacts either immediately or on a specific date. To send the email campaign activity immediately, specify `0` for the `scheduled_date` request property (results return an empty array). To send the email campaign activity on a specific date, specify the date using the `scheduled_date` request property (results return the scheduled date in an array). \n\nBefore you schedule an email campaign activity, you must update the email campaign activit" }, { "info": { "name": "DELETE an Email Campaign Activity Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/schedules", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity." } ] }, "docs": "Use this method to unschedule an email campaign activity by deleting the schedule. You can only unschedule email campaign activities that are in `SCHEDULED` status. Unscheduling reverts the email campaign activity to the status prior to `SCHEDULED`." }, { "info": { "name": "POST Test Send an Email Campaign Activity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/tests", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity. You can only test send email campaign activities that have the `primary_email` role." } ] }, "docs": "Use this method to send a test email to specific email addresses. Test emails allow you to verify how the email campaign activity will look before you send it to contacts. This method uses the `email_addresses` array in the request body to determine the recipients of the test email. The test email does not process any dynamic content in the email campaign activity. Dynamic content includes contact and custom field variables.\n\nYou can send up to 50 test emails each day. Each recipient you add to " }, { "info": { "name": "GET the HTML Preview of an Email Campaign Activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/previews", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity." } ] }, "docs": "Use this method to get the HTML preview of an email campaign activity. The HTML preview allows you to verify how the email campaign activity will look before you send it to contacts.\n\nCustom code emails (`format_type` 5) use the Constant Contact account owner's contact information to process contact, custom field, and account variables in the preview.\n\nThis method returns the HTML preview encoded as a JSON string. You will need to decode the string before you can use it as valid HTML.\n" }, { "info": { "name": "GET the Send History of an Email Campaign Activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/emails/activities/:campaign_activity_id/send_history", "params": [ { "name": "campaign_activity_id", "value": "", "type": "path", "description": "The unique ID for an email campaign activity. You can return the send history for `primary_email` and `resend` role email campaign activities." } ] }, "docs": "Use this method to return the send history of an email campaign activity. This method returns the send history as an array containing an object for each time you sent a specific email campaign activity to contacts. \n\nEach send history object contains the email campaign activity send date, the number of contacts it was sent to, and the contact lists or segments used to send it. Each send history object also includes if the send attempt completed or encountered an error, and the reason why each er" } ] } ], "bundled": true }