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 V2 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.
Segment name has to be unique. A user can not create a new segment with an existing segment name.
Bearer <<YOUR_API_KEY_HERE>>application/jsonOptional
Name of the segment.
1Max length: 100Optional
SQL query which will filter contacts based on the conditions provided
Optional
ID assigned to the segment when created.
36Max length: 36Optional
Name of the segment.
1Max length: 100Optional
SQL query which will filter contacts based on the conditions provided
Optional
Total number of contacts present in the segment
Optional
A subset of all contacts that are in this segment
Optional
ISO8601 timestamp of when the object was created
Optional
ISO8601 timestamp of when the object was last updated
Optional
ISO8601 timestamp of when the samples were last updated
Optional
ISO8601 timestamp of when the samples will be next updated
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
If not set, segment contains a Query for use with Segment v1 APIs. If set to '2', segment contains a SQL query for use in v2.
Optional
Segment status indicates whether the segment's contacts will be updated periodically
Optional
The number of times a segment has been manually refreshed since start of today in the user's timezone.
Optional
The maximum number of manual refreshes allowed per day for this segment. Currently, only 2 are allowed.
Optional
The ISO8601 timestamp when the segment was last refreshed in UTC time.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const segment_id = "segment_id";5const data = {6name: "Miss Christine Morgan",7};89const request = {10url: `/v3/marketing/segments/2.0/${segment_id}`,11method: "PATCH",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});