Program segments

Get all program segments

Retrieves all program segments for a program

GET/partner-api/v2/admin/program-segments

Response

200

Successful response

Body

*/*

program_segments*array of object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/program-segments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "program_segments": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "version_id": "text",
      "members_last_refreshed_at": 0,
      "created_at": 0,
      "updated_at": 0
    }
  ]
}

Create a program segment

Creates a program segment

POST/partner-api/v2/admin/program-segments

Body

multipart/form-data

namestring

Name of the program segment

descriptionstring

Description of the program segment

requirementsarray of string

Requirements for the program segment

Response

201422

Program segment created

Body

*/*

program_segment*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/program-segments', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "program_segment": {
    "id": "text",
    "name": "text",
    "description": "text",
    "version_id": "text",
    "members_last_refreshed_at": 0,
    "created_at": 0,
    "updated_at": 0,
    "program_segment_requirements": [
      {
        "id": "text",
        "program_segment_id": "text",
        "filter_key": "text",
        "filter_value": "text",
        "created_at": 0,
        "updated_at": 0
      }
    ]
  }
}

Get a program segment

Retrieves a program segment

GET/partner-api/v2/admin/program-segments/{id}

Path parameters

id*number

Response

200404

Successful response

Body

*/*

program_segment*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/program-segments/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "program_segment": {
    "id": "text",
    "name": "text",
    "description": "text",
    "version_id": "text",
    "members_last_refreshed_at": 0,
    "created_at": 0,
    "updated_at": 0,
    "program_segment_requirements": [
      {
        "id": "text",
        "program_segment_id": "text",
        "filter_key": "text",
        "filter_value": "text",
        "created_at": 0,
        "updated_at": 0
      }
    ]
  }
}

Delete a program segment

Delete a program segment

DELETE/partner-api/v2/admin/program-segments/{id}

Path parameters

id*number

Response

204404

No content

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/admin/program-segments/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();