---
title: "Update a channel"
method: PATCH
path: "/v1/domains/{domainId}/channels/{channelId}"
tags: ["Event Distribution Service"]
---

# Update a channel

`PATCH /v1/domains/{domainId}/channels/{channelId}`

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/channels/{channelId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/channels/:channelId/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `domainId` string, required
- `channelId` string, required

## Request body

- EDSChannelUpdate
  - `name` string
  - `supportedEventTypes` string[]
  - `status` 'active' | 'disabled'
  - `maxRetries` integer
  - `lastUpdatedBy` string, uuid

## Response `200`

OK

- EDSChannel
  - `id` string, uuid
  - `domainId` string, uuid
  - `name` string
  - `supportedEventTypes` string[]
  - `type` 'WEBHOOK'
  - `status` 'ACTIVE' | 'DISABLED'
  - `maxRetries` integer
  - `url` string
  - `createdBy` string, uuid
  - `lastUpdatedBy` string, uuid
  - `createdAt` string, date-time
  - `lastUpdatedAt` string, date-time
  - `errorRate` number, double

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)
