Twilio SendGrid Marketing Campaigns Lists API
The Twilio SendGrid Marketing Campaigns Lists API allows you to manage your contacts lists programmatically. Lists are static collections of Marketing…
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 Marketing Campaigns Lists API allows you to manage your contacts lists programmatically. Lists are static collections of Marketing Campaigns contacts. You can use this API to interact with the list objects themselves. To add contacts to a list, you must use the Contacts API.
You can also manage your lists using the Contacts menu in the Marketing Campaigns application user interface. For more information about lists and best practices for building them, see Building your Contact Lists.
Endpoints 7
Lists
- GETGet All Lists
/v3/marketing/lists?page_size=100&page_token=stringThis endpoint returns an array of all of your contact lists. - POSTCreate List
/v3/marketing/listsThis endpoint creates a new contacts list. Once you create a list, you can use the UI to trigger an automation every time you add a new contact to the list. A… - GETGet a List by ID
/v3/marketing/lists/:id?contact_sample=falseThis endpoint returns data about a specific list. Setting the optional parameter contact_sample=true returns the contact_sample in the response body. Up to 50… - DELETEDelete a list
/v3/marketing/lists/:id?delete_contacts=falseThis endpoint allows you to deletes a specific list. Optionally, you can also delete contacts associated to the list. The query parameter,… - PATCHUpdate List
/v3/marketing/lists/:idThis endpoint updates the name of a list. - DELETERemove Contacts from a List
/v3/marketing/lists/:id/contacts?contact_ids=stringThis endpoint allows you to remove contacts from a given list. The contacts will not be deleted. Only their list membership will be changed. - GETGet List Contact Count
/v3/marketing/lists/:id/contacts/countThis endpoint returns the number of contacts on a specific list.
API details
- Base URL
https://api.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 7 operations on 4 pathsGET 3DELETE 2POST 1PATCH 1
- Main resources
- Lists 7
- 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 Marketing Campaigns Lists 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 Marketing Campaigns Lists 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 “Get All Lists” (GET /v3/marketing/lists?page_size=100&page_token=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Twilio SendGrid Marketing Campaigns Lists API?
The Twilio SendGrid Marketing Campaigns Lists API allows you to manage your contacts lists programmatically. Lists are static collections of Marketing… It is listed under Communication and has 7 endpoints.
Who publishes the Twilio SendGrid Marketing Campaigns Lists 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 Marketing Campaigns Lists API?
Requests go to https://api.sendgrid.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio SendGrid Marketing Campaigns Lists API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Marketing Campaigns Lists API have?
7 operations on 4 paths (3 GET, 2 DELETE, 1 POST, 1 PATCH). The largest groups are Lists.
Is forking the Twilio SendGrid Marketing Campaigns Lists API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.