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.
The Refresh Segment operation allows customers with Marketing Campaigns Basic or Advanced plans to manually refresh segments. You can refresh a segment twice per day. Refreshes will be reset at midnight in the timezone stored for the segment. A segment cannot be refreshed more than once within one hour, and the endpoint has a rate limit of 10 requests per day that is reset at 0:00 UTC. Manually refreshing a segment does not affect the segment's backoff.
Manually refresh a segment by segment ID.
Bearer <<YOUR_API_KEY_HERE>>36Max length: 36application/jsonThe user's timezone. The timezone is used to reset the refresh count at midnight in the user's local time. Only IANA time zone format is accepted.
The refresh was accepted and a request was sent to process.
The ID of the manual refresh job. Used only for internal purposes.
1const client = require('@sendgrid/client');2client.setApiKey(process.env.SENDGRID_API_KEY);34const segment_id = "f15982c1-a82c-4e87-a6b2-a4a63b4b7644";5const data = {6"user_time_zone": "America/Chicago"7};89const request = {10url: `/v3/marketing/segments/2.0/refresh/${segment_id}`,11method: 'POST',12body: data13}1415client.request(request)16.then(([response, body]) => {17console.log(response.statusCode);18console.log(response.body);19})20.catch(error => {21console.error(error);22});