Channels endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/channels

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no
cursor	query	string	no
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	PageOfChannelDto

POST /api/projects/{projectId}/channels

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): AddChannelRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
kind	string	yes

Status	Meaning	Body
201	Created	ChannelDto

PATCH /api/projects/{projectId}/channels/{channelId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
channelId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): UpdateChannelRequest

Field	Type	Required	Notes
name	string or null	yes
kind	string or null	yes
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	ChannelDto

DELETE /api/projects/{projectId}/channels/{channelId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
channelId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Status	Meaning	Body
204	No Content	none