Segmenting Contacts V2
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.
Create Segment
POST /v3/marketing/segments/2.0
Base url: https://api.sendgrid.com
Segment name has to be unique. A user can not create a new segment with an existing segment name.
Authentication
- API Key
Headers
Request Body
Name of the segment.
maxLength: 100minLength: 1The 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
Responses
ID assigned to the segment when created.
format: uuidmaxLength: 36minLength: 36Name of the segment.
maxLength: 100minLength: 1SQL query which will filter contacts based on the conditions provided
Total number of contacts present in the segment
A subset of all contacts that are in this segment
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: TrueISO8601 timestamp of when the object was created
ISO8601 timestamp of when the object was last updated
ISO8601 timestamp of when the samples were last updated
ISO8601 timestamp of when the samples will be next updated
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: TrueIf 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.
Segment status indicates whether the segment's contacts will be updated periodically
Status of query validation. PENDING, VALID, or INVALID
Describes any errors that were encountered during query validation
The number of times a segment has been manually refreshed since start of today in the user's timezone.
The maximum number of manual refreshes allowed per day for this segment. Currently, only 2 are allowed.
The ISO8601 timestamp when the segment was last refreshed in UTC time.
If the request is incorrect, an array of errors will be returned.
the field in the request body that is incorrect
a description of what is specifically wrong with the field passed in the request
If the request is incorrect, an array of errors will be returned.
the field in the request body that is incorrect
a description of what is specifically wrong with the field passed in the request
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.
