Twilio SendGrid Marketing Campaigns Segments 2.0 API
The Twilio SendGrid Marketing Campaigns Segments V2 API allows you to create, edit, and delete segments as well as retrieve a list of segments or an…
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 Segments V2 API allows you to create, edit, and delete segments as well as retrieve a list of segments or an individual segment by ID.
Segments are similar to contact lists, except they update dynamically over time as information stored about your contacts or the criteria used to define your segments changes. When you segment your audience, you are able to create personalized Automation emails and Single Sends that directly address the wants and needs of your particular audience.
Note that Twilio SendGrid checks for newly added or modified contacts who meet a segment's criteria on an hourly schedule. Only existing contacts who meet a segment's criteria will be included in the segment searches within 15 minutes.
Segments built using engagement data such as "was sent" or "clicked" will take approximately 30 minutes to begin populating.
Segment samples and counts are refreshed approximately once per hour; they do not update immediately. If no contacts are added to or removed from a segment since the last refresh, the sample and UI count displayed will be refreshed at increasing time intervals with a maximum sample and count refresh delay of 24 hours.
You can also manage your Segments with the Marketing Campaigns application user interface. See Segmenting Your Contacts for more information.
Endpoints 6
Segmenting Contacts V2
- GETGet List of Segments
/v3/marketing/segments/2.0?ids=string&parent_list_ids=string&no_parent_list_id=falseThis endpoint allows you to retrieve a list of segments. The query param parent_list_ids is treated as a filter. Any match will be returned. Zero matches will… - POSTCreate Segment
/v3/marketing/segments/2.0Segment name has to be unique. A user can not create a new segment with an existing segment name. - GETGet Segment by ID
/v3/marketing/segments/2.0/:segment_id?contacts_sample=trueGet Marketing Campaigns Segment by ID - DELETEDelete segment
/v3/marketing/segments/2.0/:segment_idThis endpoint allows you to delete a segment by ID. - PATCHUpdate Segment
/v3/marketing/segments/2.0/:segment_idSegment name has to be unique. A user can not create a new segment with an existing segment name. - POSTManually refresh a segment
/v3/marketing/segments/2.0/refresh/:segment_idManually refresh a segment by segment ID.
API details
- Base URL
https://api.sendgrid.com- Authentication
- A bearer token in the Authorization header
- Operations
- 6 operations on 3 pathsGET 2POST 2PATCH 1DELETE 1
- Main resources
- Segmenting Contacts V2 6
- 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 Segments 2.0 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 Segments 2.0 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 List of Segments” (GET /v3/marketing/segments/2.0?ids=string&parent_list_ids=string&no_parent_list_id=false), 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 Segments 2.0 API?
The Twilio SendGrid Marketing Campaigns Segments V2 API allows you to create, edit, and delete segments as well as retrieve a list of segments or an… It is listed under Communication and has 6 endpoints.
Who publishes the Twilio SendGrid Marketing Campaigns Segments 2.0 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 Segments 2.0 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 Segments 2.0 API?
With A bearer token in the Authorization header.
How many endpoints does the Twilio SendGrid Marketing Campaigns Segments 2.0 API have?
6 operations on 3 paths (2 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are Segmenting Contacts V2.
Is forking the Twilio SendGrid Marketing Campaigns Segments 2.0 API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.