Twilio SendGrid Scheduled Sends API
The Twilio SendGrid Scheduled Sends API allows you to cancel or pause the send of one or more emails using a batch ID. A batch_id groups multiple scheduled…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Twilio SendGrid Scheduled Sends API allows you to cancel or pause the send of one or more emails using a batch ID.
A batch_id groups multiple scheduled mail send requests together with the same ID. You can cancel or pause all of the requests associated with a batch ID up to 10 minutes before the scheduled send time.
See Canceling a Scheduled Send for a guide on creating a batch_id, assigning it to a scheduled send, and modifying the send.
See the Mail API's batching operations to validate a batch_id and retrieve all scheduled sends as an array.
When a batch is canceled, all messages associated with that batch will stay in your sending queue. When their send_at value is reached, they will be discarded.
When a batch is paused, all messages associated with that batch will stay in your sending queue, even after their send_at value has passed. This means you can remove a pause status, and your scheduled send will be delivered once the pause is removed. Any messages left with a pause status that are more than 72 hours old will be discarded as Expired.
Endpoints 5
Scheduled Sends
- GETRetrieve all scheduled sends
/v3/user/scheduled_sendsThis endpoint allows you to retrieve all cancelled and paused scheduled send information. This endpoint will return only the scheduled sends that are… - POSTCancel or pause a scheduled send
/v3/user/scheduled_sendsThis endpoint allows you to cancel or pause a scheduled send associated with a batch_id. Passing this endpoint a batch_id and status will cancel or pause the… - GETRetrieve scheduled send
/v3/user/scheduled_sends/:batch_idThis endpoint allows you to retrieve the cancel/paused scheduled send information for a specific batch_id. - DELETEDelete a cancellation or pause from a scheduled send
/v3/user/scheduled_sends/:batch_idThis endpoint allows you to delete the cancellation/pause of a scheduled send. Scheduled sends cancelled less than 10 minutes before the scheduled time are… - PATCHUpdate a scheduled send
/v3/user/scheduled_sends/:batch_idThis endpoint allows you to update the status of a scheduled send for the given batch_id. If you have already set a cancel or pause status on a scheduled send…
API details
- Base URL
https://api.sendgrid.comhttps://api.eu.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 5 operations on 2 pathsGET 2POST 1PATCH 1DELETE 1
- Main resources
- Scheduled Sends 5
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- Documentation · OpenAPI document · Terms of service · Support
How to test the Twilio SendGrid Scheduled Sends API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Scheduled Sends API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve all scheduled sends” (GET /v3/user/scheduled_sends), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Scheduled Sends API?
The Twilio SendGrid Scheduled Sends API allows you to cancel or pause the send of one or more emails using a batch ID. A batch_id groups multiple scheduled… It is listed under Communication and has 5 endpoints.
Who publishes the Twilio SendGrid Scheduled Sends API?
It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Twilio SendGrid Scheduled Sends API?
Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Twilio SendGrid Scheduled Sends API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Scheduled Sends API have?
5 operations on 2 paths (2 GET, 1 POST, 1 PATCH, 1 DELETE). The largest groups are Scheduled Sends.
Is forking the Twilio SendGrid Scheduled Sends API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.