Program segments
Retrieves all program segments for a program
Authorizations
Responses
200
Successful response
application/json
get
GET /partner-api/v2/admin/program-segments HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
200
Successful response
{
"program_segments": [
{
"id": "text",
"name": "text",
"description": "text",
"version_id": "text",
"members_last_refreshed_at": 1,
"created_at": 1,
"updated_at": 1
}
]
}Creates a program segment
Authorizations
Body
namestringOptional
Name of the program segment
descriptionstringOptional
Description of the program segment
requirementsarrayOptional
Requirements for the program segment
Responses
201
Program segment created
application/json
422
Unprocessable entity
post
POST /partner-api/v2/admin/program-segments HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 54
"name='text'&description='text'&requirements=[]"{
"program_segment": {
"id": "text",
"name": "text",
"description": "text",
"version_id": "text",
"members_last_refreshed_at": 1,
"created_at": 1,
"updated_at": 1,
"program_segment_requirements": [
{
"id": "text",
"program_segment_id": "text",
"filter_key": "text",
"filter_value": "text",
"created_at": 1,
"updated_at": 1
}
]
}
}Retrieves a program segment
Authorizations
Path parameters
idnumberRequired
Responses
200
Successful response
application/json
404
Program segment not found
get
GET /partner-api/v2/admin/program-segments/{id} HTTP/1.1
Host:
X-API-Key: YOUR_API_KEY
Accept: */*
{
"program_segment": {
"id": "text",
"name": "text",
"description": "text",
"version_id": "text",
"members_last_refreshed_at": 1,
"created_at": 1,
"updated_at": 1,
"program_segment_requirements": [
{
"id": "text",
"program_segment_id": "text",
"filter_key": "text",
"filter_value": "text",
"created_at": 1,
"updated_at": 1
}
]
}
}