Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("segment_id","{{segment_identifier}}")
' Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}"
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://rest.iad-01.braze.com/segments/details",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)
Curl Command
curl -G -d "segment_id=%7B%7Bsegment_identifier%7D%7D"
-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/segments/details
Postman Collection Item JSON
{
"name": "Segment Details",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"type": "text"
}
],
"url": {
"raw": "https://{{instance_url}}/segments/details?segment_id={{segment_identifier}}",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"segments",
"details"
],
"query": [
{
"key": "segment_id",
"value": "{{segment_identifier}}",
"description": "(Required) String\n\nSegment API identifier"
}
]
},
"description": "This endpoint allows you to retrieve relevant information on the segment, which can be identified by the `segment_id`.\n\n### Request Components\n- [Segment Identifier](https://www.braze.com/docs/api/identifier_types/)\n\n## Response\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"message\": (required, string) the status of the export, returns 'success' when completed without errors,\n \"created_at\" : (string) date created as ISO 8601 date,\n \"updated_at\" : (string) date last updated as ISO 8601 date,\n \"name\" : (string) segment name,\n \"description\" : (string) human-readable description of filters,\n \"text_description\" : (string) segment description, \n \"tags\" : (array) tag names associated with the segment\n}\n```"
},
"response": [
]
}
