Segmentation V2 APIs are now available! See the Getting Started guide to find out what new features are available.
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.
The Marketing Campaigns Segments API allows you to create, edit, and delete segments as well as retrieve a list of segments or an individual segment by ID.
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.
For more information on creating segments with the Twilio SendGrid Marketing Campaigns UI see "Segmenting your Contacts."
For help with Segmentation Query Language, see our Segmentation Query Language reference
The Segmentation v1 API was deprecated on December 31, 2022. Following deprecation, all segments created in the Marketing Campaigns user interface began using the Segmentation v2 API.
To enable manual migration and data retrieval, the GET and DELETE v1 API endpoints will remain available. The POST (create) and PATCH (update) v1 endpoints were removed on January 31, 2023 because it is no longer possible to create new v1 segments or modify existing ones. See our Segmentation v1 to v2 upgrade instructions to manually migrate your segments to the v2 API.
This endpoint allows you to retrieve a single segment by ID.
Bearer <<YOUR_API_KEY_HERE>>36Max length: 36Optional
Defaults to false. Set to true to return the parsed SQL AST as a JSON object in the field query_json
Optional
36Max length: 36Optional
Optional
ISO8601 of created timestamp
Optional
Name of the segment.
1Max length: 100Optional
The id of the list if this segment is a child of a list. This implies the query AND CONTAINS(list_ids, ${parent_list_id})
36Max length: 36Optional
ISO8601 timestamp the sample was last updated
Optional
ISO8601 timestamp the object was last updated
Optional
ISO8601 string that is equal to sample_updated_at plus an internally calculated offset that depends on how often contacts enter or exit segments as the scheduled pipeline updates the samples.
Optional
Optional
AST representation of the query DSL
Optional
The array of list ids to filter contacts on when building this segment. It allows only one such list id for now. We will support more in future
Optional
SQL query which will filter contacts based on the conditions provided
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const segment_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";56const request = {7url: `/v3/marketing/segments/${segment_id}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});