Channel data
Objects

Set channel data

Changed on

Sets the channel data for the specified object and channel. If no object exists in the current environment for the given collection and object_id, Knock will create the object as part of this request.

put/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/objects/{collection}/{object_id}/channel_data/{channel_id}
  • Auth: HTTP bearer

Path parameters

object_idstring required

Unique identifier for the object.

collectionstring required

The collection this object belongs to.

channel_idstring uuid required

The unique identifier for the channel.

Request body

Example request

{
  "data": {
    "tokens": [
      "push_token_1"
    ]
  }
}

Response

OK

__typenamestring required

The typename of the schema.

channel_idstring uuid required

The unique identifier for the channel.

provider'push_fcm' | 'push_apns' | 'push_aws_sns' | 'push_expo' | 'push_one_signal' | 'chat_slack' | 'chat_ms_teams' | 'chat_discord' | 'http_knock_webhook'

The type of provider.

Example response

{
  "__typename": "ChannelData",
  "channel_id": "123e4567-e89b-12d3-a456-426614174000",
  "data": {
    "devices": [
      {
        "locale": null,
        "timezone": null,
        "token": "device_1"
      }
    ],
    "tokens": [
      "push_token_1"
    ]
  }
}

Changes

  • 6f88a4142e34Revision changes
    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 8723e10bfba6Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status