Segmenting Contacts
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
Get Segment by ID
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.
GET /v3/marketing/segments/{segment_id}
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a single segment by ID.
Authentication
- API Key
Headers
Path Parameters
Query String
Defaults to false. Set to true to return the parsed SQL AST as a JSON object in the field query_json
Responses
ISO8601 of created timestamp
format: date-timeName of the segment.
maxLength: 100minLength: 1The id of the list if this segment is a child of a list. This implies the query AND CONTAINS(list_ids, ${parent_list_id})
ISO8601 timestamp the sample was last updated
format: date-timeISO8601 timestamp the object was last updated
format: date-timeISO8601 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.
ID assigned to a contact when added to the system.
format: uuidmaxLength: 36pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}Email of the contact. This is a reserved field.
format: emailmaxLength: 254minLength: 3Alternate emails of the contact. This is a reserved field.
minItems: 0uniqueItems: TrueFirst name of the contact. This is a reserved field.
minLength: 1Last name of the contact. This is a reserved field.
minLength: 1First line of address of the contact. This is a reserved field.
minLength: 0Second line of address of the contact. This is a reserved field.
minLength: 0City associated with the contact. This is a reserved field.
minLength: 0pattern: ^[a-zA-Z\u0080-\u024F\s\/\-\)\(\`\.\"\']+$State associated with the contact. This is a reserved field.
minLength: 0Zipcode associated with the address of the contact. This is a reserved field.
Country associated with the address of the contact. This is a reserved field.
minLength: 0IDs of all lists the contact is part of
uniqueItems: TrueThe user may choose to create up to 120 custom fields or none at all. This is not a reserved field.
IDs of all segments the contact is part of
uniqueItems: TrueAST representation of the query DSL
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
uniqueItems: TrueSQL query which will filter contacts based on the conditions provided
{
"id": "58567a46-305e-48d1-b4f8-a006c906920e",
"contacts_count": 9266921,
"created_at": "2085-08-08T21:07:05.692Z",
"sample_updated_at": "3407-09-25T04:25:02.140Z",
"updated_at": "4431-05-07T22:23:22.352Z",
"contacts_sample": [
{
"contact_id": "c1183ada-b784-49ac-9b1f-50e73578a6dc",
"primary_email": "ft88@d.izxx",
"alternate_emails": [
"yKDUP11FDch@QoU.vwy",
"ZNSN5@czAMqPi.at",
"7wr51kFVVKlcBSH@DWxOueOZepetzBrku.qosk",
"iib-ObtO7Fxz5@vLJPRIFKPOqJGCEqcIDab.ypn"
],
"first_name": "est",
"last_name": "eiusmod in laboris velit cupidatat",
"address_line_1": "sunt aliqua",
"address_line_2": "sit proident Lorem veniam labore",
"city": "\u009c\u020e\u0163\u0238\u00db\t\u010d\u000bC\u0141",
"state_province_region": "ut proident",
"postal_code": 30296612,
"country": "do reprehenderit qui",
"custom_fields": {
"custom_field_name2": "in consectetur ut aliqua sint",
"custom_field_name1": "esse"
}
}
],
"name": "culpa",
"query_dsl": "cillum eiusmod",
"parent_list_id": "2357714d-3d82-4c80-826c-b44a4147f81c",
"next_sample_update": ""
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
