Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: develop
Fetching contributors…

Cannot retrieve contributors at this time

101 lines (75 sloc) 2.726 kb
layout weight title seo navigation
page
0
Schedule
title description
Schedule Marketing Emails by API - SendGrid Documentation | SendGrid
Schedule SendGrid marketing emails using the schedule endpoint of the SendGrid Marketing Email API.
show
true

This endpoint allows you to add, view, or remove scheduled delivery events for Marketing Emails.

{% info %} If you wish to send a marketing email immediately, leave off the at and after parameters. {% endinfo %}

{% anchor h2 %} add {% endanchor %}

Schedule a delivery time for an existing Marketing Email.

{% parameters add %} {% parameter 'name' 'Yes' 'Must be an existing Marketing Email.' 'Marketing Email to schedule delivery for. (If Marketing Email should be sent now, include no additional parameters.)' %} {% parameter 'at' 'No' 'Date / Time must be provided in ISO 8601 format (YYYY-MM-DDTHH:MM:SS+-HH:MM)' 'Date / Time to schedule marketing email Delivery.' %} {% parameter 'after' 'No' 'Must be a positive integer.' 'Number of minutes until delivery should occur.' %} {% endparameters %}

{% apiexample add POST https://api.sendgrid.com/api/newsletter/schedule/add name=test&at=2013-12-20T11:55:00-05:00&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} { "message": "success" } {% endresponse %} {% response xml %} success

{% endresponse %} {% endapiexample %}


{% anchor h2 %} get {% endanchor %}

Retrieve the scheduled delivery time for an existing Marketing Email.

{% parameters get %} {% parameter 'name' 'Yes' 'Must be an existing Marketing Email.' 'Retrieve the delivery time scheduled for this Marketing Email.' %} {% endparameters %}

{% apiexample get POST https://api.sendgrid.com/api/newsletter/schedule/get name=SendGrid_Test2&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} { "date": "2012-09-05 21:22:02" } {% endresponse %} {% response xml %} success

{% endresponse %} {% endapiexample %}


{% anchor h2 %} delete {% endanchor %}

Cancel a scheduled send for a Marketing Email.

{% parameters delete %} {% parameter 'name' 'Yes' 'Must be an existing Marketing Email' 'Remove the scheduled delivery time from an existing Marketing Email.' %} {% endparameters %}

{% apiexample delete POST https://api.sendgrid.com/api/newsletter/schedule/delete name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} { "message": "success" } {% endresponse %} {% response xml %} success

{% endresponse %} {% endapiexample %}

Jump to Line
Something went wrong with that request. Please try again.