PIpismo
Channels

Update channel

Updates the description of an existing channel.<br>

You can update description, but the channel code remains fixed.

This endpoint generates the following events:

Refer to Data and reporting for more information about events and setting up event notifications.

patch/corporate/v1/channels/{channel}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/corporate/v1/channels/{channel}
  • Auth
    HTTP bearer

Path parameters

channelstring required

Channel code

Request body

descriptionstring required

Text describing the channel

Example request

{
  "description": "GDP channel"
}

Response

OK. Returns the updated channel.

channelstring required

Alphanumeric channel code

created_atstring date-time required

Timestamp indicating when the channel was created, expressed in RFC3339 format with millisecond precision.

descriptionstring

Text describing the channel

updated_atstring date-time nullable

Timestamp indicating the last update to the channel in RFC3339 format, displayed in milliseconds.

deleted_atstring date-time nullable

Timestamp that indicates when the channel was soft-deleted. Null if the channel is active.

Example response

{
  "channel": "GDP",
  "created_at": "2026-02-26T10:30:00.123Z",
  "description": "GDP channel",
  "updated_at": "2026-03-10T14:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.