Create

POST/api/v1/channels

This endpoint allows you to create a custom channel for your own messaging platform.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Body Paramsapplication/json

namestringrequired
brandNamestringrequired
metadataobjectrequired
Child attributes
- platform_channel_idstringrequired
- inboundobjectrequired
  Child attributes
  verify_tokenstringrequired
- outboundobjectrequired
  Child attributes
  urlstringrequired
  headersarray[object]required
  Child attributes
  keystringoptional
  valuestringoptional

Responses

201

Created

Request

curl -X POST "https://apigw.klinkcx.com/api/v1/channels" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Your Custom Channel Name",
  "brandName": "Your Custom Channel",
  "metadata": {
    "platform_channel_id": "03939393k3kk3k3",
    "inbound": {
      "verify_token": "3939393939203902930"
    },
    "outbound": {
      "url": "https://webhook.test",
      "headers": [
        {
          "key": "MyKey",
          "value": "testing"
        }
      ]
    }
  }
}'