Contacts API - Segments
Elements that can be shared among more than one endpoint definition.
Retrieve a segment
GET /v3/contactdb/segments/{segment_id}
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a single segment with the given ID.
Authentication
- API Key
Headers
Path Parameters
Query String
The ID of the segment you want to request.
default: NoneResponses
The name of this segment.
The list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list.
The conditions for a recipient to be included in this segment.
The count of recipients in this list. This is not included on creation of segments.
{
"name": "Last Name Miller",
"list_id": 4,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
},
{
"field": "last_clicked",
"value": "01/02/2015",
"operator": "gt",
"and_or": "and"
},
{
"field": "clicks.campaign_identifier",
"value": "513",
"operator": "eq",
"and_or": "or"
}
],
"recipient_count": 1234
}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"
}
]
}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; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.