Skip to main content
PATCH
/
api
/
v3
/
channels
UpdateChannel
curl --request PATCH \
  --url https://your-sift-api-url.com/api/v3/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": {
    "channelId": "<string>",
    "name": "<string>",
    "assetId": "<string>",
    "description": "<string>",
    "unitId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "enumTypes": [
      {
        "name": "<string>",
        "key": 123,
        "isSigned": true
      }
    ],
    "bitFieldElements": [
      {
        "name": "<string>",
        "index": 123,
        "bitCount": 123
      }
    ],
    "displayDescription": "<string>",
    "displayUnitId": "<string>"
  },
  "updateMask": "<string>"
}
'
{
  "channel": {
    "channelId": "<string>",
    "name": "<string>",
    "assetId": "<string>",
    "description": "<string>",
    "unitId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "dataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "enumTypes": [
      {
        "name": "<string>",
        "key": 123,
        "isSigned": true
      }
    ],
    "bitFieldElements": [
      {
        "name": "<string>",
        "index": 123,
        "bitCount": 123
      }
    ],
    "displayDescription": "<string>",
    "displayUnitId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The request for a call to ChannelService_UpdateChannel.

The request for a call to ChannelService_UpdateChannel.

​
channel
object
required
​
updateMask
string
required

The list of fields to be updated. The fields available to be updated are display_description, display_units, and metadata.

Response

A successful response.

The result of a call to ChannelService_UpdateChannel.

​
channel
object
required