POST /channel-custom-fields.json

Bearer auth

application/json

Body Required

channelId integer(int32) Required

Channel
customFieldId integer(int32) Required

Custom field
purpose string Required

Purpose

Values are name or description.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- channelId integer(int32) Required
  
  Channel
- createdAt string(date-time)
  
  Created at
- customFieldId integer(int32) Required
  
  Custom field
- id integer(int32)
  
  Id
- purpose string Required
  
  Purpose
  
  Values are name or description.
- updatedAt string(date-time)
  
  Updated at

POST /channel-custom-fields.json

curl \
 --request POST 'http://api.example.com/v1/channel-custom-fields.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"channelId":42,"customFieldId":42,"purpose":"name"}'

Request examples

{
  "channelId": 42,
  "customFieldId": 42,
  "purpose": "name"
}

Response examples (200)

{
  "channelId": 42,
  "createdAt": "2025-05-04T09:42:00Z",
  "customFieldId": 42,
  "id": 42,
  "purpose": "name",
  "updatedAt": "2025-05-04T09:42:00Z"
}