Twilio SendGrid Legacy Marketing Campaigns Campaigns API
The Twilio SendGrid Legacy Marketing Campaigns Campaigns API allows you to manage your marketing email messages programmatically. This API is operational, but…
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 Legacy Marketing Campaigns Campaigns API allows you to manage your marketing email messages programmatically. This API is operational, but we recommend using the current version of Marketing Campaigns to manage your marketing messages with SendGrid Single Sends and Automations.
See Migrating from Legacy Marketing Campaigns for more information.
Endpoints 11
Campaigns API
- GETRetrieve all Campaigns
/v3/campaigns?limit=10&offset=0This endpoint allows you to retrieve a paginated list of all of your campaigns. Returns campaigns in reverse order they were created (newest first). Returns… - POSTCreate a Campaign
/v3/campaignsThis endpoint allows you to create a campaign. In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we… - GETRetrieve a single campaign
/v3/campaigns/:campaign_idThis endpoint allows you to retrieve a specific campaign. - DELETEDelete a Campaign
/v3/campaigns/:campaign_idThis endpoint allows you to delete a specific campaign. - PATCHUpdate a Campaign
/v3/campaigns/:campaign_idThis endpoint allows you to update a specific campaign. This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many… - GETView Scheduled Time of a Campaign
/v3/campaigns/:campaign_id/schedulesThis endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent. - POSTSchedule a Campaign
/v3/campaigns/:campaign_id/schedulesThis endpoint allows you to schedule a specific date and time for your campaign to be sent. If you have the flexibility, it's better to schedule mail for… - DELETEUnschedule a Scheduled Campaign
/v3/campaigns/:campaign_id/schedulesThis endpoint allows you to unschedule a campaign that has already been scheduled to be sent. A successful unschedule will return a 204. If the specified… - PATCHUpdate a Scheduled Campaign
/v3/campaigns/:campaign_id/schedulesThis endpoint allows to you change the scheduled time and date for a campaign to be sent. - POSTSend a Campaign
/v3/campaigns/:campaign_id/schedules/nowThis endpoint allows you to immediately send an existing campaign. Normally a POST request would have a body, but since this endpoint is telling us to send a… - POSTSend a Test Campaign
/v3/campaigns/:campaign_id/schedules/testThis endpoint allows you to send a test campaign. To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]
API details
- Base URL
https://api.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 11 operations on 5 pathsPOST 4GET 3PATCH 2DELETE 2
- Main resources
- Campaigns API 11
- 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 Legacy Marketing Campaigns Campaigns 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 Legacy Marketing Campaigns Campaigns 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 Campaigns” (GET /v3/campaigns?limit=10&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Legacy Marketing Campaigns Campaigns API?
The Twilio SendGrid Legacy Marketing Campaigns Campaigns API allows you to manage your marketing email messages programmatically. This API is operational, but… It is listed under Communication and has 11 endpoints.
Who publishes the Twilio SendGrid Legacy Marketing Campaigns Campaigns 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 Legacy Marketing Campaigns Campaigns API?
Requests go to https://api.sendgrid.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio SendGrid Legacy Marketing Campaigns Campaigns API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Legacy Marketing Campaigns Campaigns API have?
11 operations on 5 paths (4 POST, 3 GET, 2 PATCH, 2 DELETE). The largest groups are Campaigns API.
Is forking the Twilio SendGrid Legacy Marketing Campaigns Campaigns API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.