This endpoint allows you to add, view, or remove scheduled delivery events for Newsletters.
Info
If you wish to send a newsletter immediately, leave off the at and after parameters.
add
Schedule a delivery time for an existing Newsletter.
| Parameter |
Required |
Requirements |
Description |
| name |
Yes |
Must be an existing Newsletter. |
Newsletter to schedule delivery for. (If Newsletter should be sent now, include no additional parameters.) |
| at |
No |
Date / Time must be provided in ISO 8601 format (YYYY-MM-DD HH:MM:SS+-HH:MM) |
Date / Time to schedule newsletter Delivery. |
| after |
No |
Must be a positive integer. |
Number of minutes until delivery should occur. |
Call
1
| http://sendgrid.com/api/newsletter/schedule/add.json?name=test&at=2012-09-05v1_(deprecated)18%3A35%3A00&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
| {
"message": "success"
}
|
Response: Error
1
2
3
4
5
6
| {
"message": "error",
"errors": [
"...error messages..."
]
}
|
Call
1
| http://sendgrid.com/api/newsletter/schedule/add.xml?name=test&at=2012-09-05v1_(deprecated)18%3A35%3A00&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
4
5
| <?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message>success</message>
</result>
|
Response: Error
1
2
3
4
5
| <?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message>error: reason</message>
</result>
|
get
Retrieve the scheduled delivery time for an existing Newsletter.
| Parameter |
Required |
Requirements |
Description |
| name |
Yes |
Must be an existing Newsletter. |
Retrieve the delivery time scheduled for this Newsletter. |
Call
1
| http://sendgrid.com/api/newsletter/schedule/get.json?name=SendGridv1_(deprecated)NLv1_(deprecated)Test2&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
| {
"date": "2012-09-05 21:22:02"
}
|
Response: Error
1
2
3
4
5
6
| {
"message": "error",
"errors": [
"...error messages..."
]
}
|
Call
1
| http://sendgrid.com/api/newsletter/schedule/get.xml?name=SendGridv1_(deprecated)NLv1_(deprecated)Test2&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
4
5
| <?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message>success</message>
</result>
|
Response: Error
1
2
3
4
5
6
7
| <?xml version="1.0" encoding="ISO-8859-1"?>
<scheduled>
<date>
2012-09-05 21:22:02
</date>
</scheduled>
|
delete
Cancel a scheduled send for a Newsletter.
| Parameter |
Required |
Requirements |
Description |
| name |
Yes |
Must be an existing Newsletter |
Remove the scheduled delivery time from an existing Newsletter. |
Call
1
| sendgrid.com/api/newsletter/schedule/delete.json?name=test&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
| {
"message": "success"
}
|
Response: Error
1
2
3
4
5
6
| {
"message": "error",
"errors": [
"...error messages..."
]
}
|
Call
1
| sendgrid.com/api/newsletter/schedule/delete.xml?name=test&api_user=SGusername&api_key=SGpassword
|
Response: Success
1
2
3
4
5
| <?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message>success</message>
</result>
|
Response: Error
1
2
3
4
5
| <?xml version="1.0" encoding="ISO-8859-1"?>
<result>
<message>error: reason</message>
</result>
|