Update a channel route | CloudRaker documentation

Updates a route’s name, target, payload mapping, RUN-IF gate, or status. Authorization: organization administrators only. Returns 404 if the channel or route is missing.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

channelIdstringRequired

routeIdstringRequired

Request

This endpoint expects an object.

namestringOptional1-120 characters

targetobjectOptional

payloadMappingmap from strings to strings or nullOptional

runIfany or nullOptional

statusenumOptional

Allowed values:

Response

The updated route.

routeobject

$	curl -X PATCH https://api.cloudraker.com/channels/channelId/routes/routeId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"route": {
3	"_id": "5f8d0d55b54764421b7156c3",
4	"channelId": "channel_9a8b7c6d5e4f3a2b1c0d",
5	"name": "Critical Alerts Route",
6	"target": {
7	"kind": "playbook",
8	"playbookId": "playbook_12345abcde",
9	"spaceId": "space_67890fghij"
10	},
11	"payloadMapping": {},
12	"status": "active",
13	"createdAt": "2024-06-01T12:00:00Z",
14	"archivedAt": "null"
15	}
16	}