Channels
Channels are a required field for every program type. A channel can be used only with its specified applicableProgramType. The channel also defines the program statuses available to program members.
If you change a channel’s statuses after creating a program, the program uses the updated list for future status changes. Existing program membership records retain their current statuses.
Query
Query channels as standard assets. The API does not provide an endpoint for retrieving a channel by ID.
Browse
GET /rest/asset/v1/channels.json?offset=10
{
"success": true,
"warnings": [],
"errors": [],
"requestId": "651#1504ebbbfcf",
"result": [
{
"id": 3,
"name": "Blog",
"applicableProgramType": "program",
"progressionStatuses": [
{
"name": "Not in Program",
"step": 0,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Invited",
"step": 10,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Visited Booth",
"step": 20,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Influenced",
"step": 30,
"description": null,
"hidden": false,
"success": true
}
],
"createdAt": "2015-07-15T11:40:57Z+0000",
"updatedAt": "2015-07-15T11:40:57Z+0000"
},
{
"id": 4,
"name": "Online Advertising",
"applicableProgramType": "program",
"progressionStatuses": [
{
"name": "Not in Program",
"step": 0,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Invited",
"step": 10,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Registered",
"step": 20,
"description": null,
"hidden": false,
"success": false
},
{
"name": "No Show",
"step": 30,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Attended",
"step": 40,
"description": null,
"hidden": false,
"success": true
}
],
"createdAt": "2015-07-15T11:40:58Z+0000",
"updatedAt": "2015-07-15T11:40:58Z+0000"
}
]
}
By Name
GET /rest/asset/v1/channel/byName.json?name=Online Advertising
{
"success": true,
"warnings": [],
"errors": [],
"requestId": "394c#1504eb476ed",
"result": [
{
"id": 4,
"name": "Online Advertising",
"applicableProgramType": "program",
"progressionStatuses": [
{
"name": "Not in Program",
"step": 0,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Invited",
"step": 10,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Registered",
"step": 20,
"description": null,
"hidden": false,
"success": false
},
{
"name": "No Show",
"step": 30,
"description": null,
"hidden": false,
"success": false
},
{
"name": "Attended",
"step": 40,
"description": null,
"hidden": false,
"success": true
}
],
"createdAt": "2015-07-15T11:40:58Z+0000",
"updatedAt": "2015-07-15T11:40:58Z+0000"
}
]
}
recommendation-more-help
marketo-developer-help