Skip to content

Channels

Channels represent specific content outlets within an organization -- for example, a publication's website, newsletter, podcast, or event series. Each channel belongs to exactly one outlet.

Channel Types

The type field accepts these values:

  • website
  • newsletter
  • podcast
  • tv_broadcast
  • print
  • event
  • award

create_channel

Create a new channel within an outlet.

Parameters

ParameterTypeRequiredDescription
outlet_idstring (UUID)YesParent outlet ID
typestringYesChannel type (see list above)
namestringNoChannel name (may differ from outlet)
descriptionstringNoDescription
urlstringNoChannel-specific URL
frequencystringNodaily, weekly, monthly, quarterly, annual
attributesobjectNoChannel-type-specific metrics (JSONB). Use for audience size, subscriber count, etc.

Example

json
{
  "name": "create_channel",
  "arguments": {
    "outlet_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "newsletter",
    "name": "TechCrunch Daily",
    "url": "https://techcrunch.com/newsletter",
    "frequency": "daily",
    "attributes": { "subscriber_count": 500000 }
  }
}

get_channel

Get a channel by ID, including its parent outlet.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesChannel ID

Example

json
{
  "name": "get_channel",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

list_channels

List channels with optional filters.

Parameters

ParameterTypeRequiredDescription
outlet_idstring (UUID)NoFilter by outlet
typestringNoFilter by channel type
include_archivedbooleanNoInclude archived channels (default: false)
limitnumberNoMax results (default: 50)
offsetnumberNoOffset for pagination (default: 0)

Example

json
{
  "name": "list_channels",
  "arguments": {
    "outlet_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "podcast"
  }
}

update_channel

Update channel fields.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesChannel ID
namestringNoChannel name
descriptionstringNoDescription
urlstringNoChannel URL
frequencystringNoFrequency
attributesobjectNoChannel-type-specific metrics (JSONB)

Example

json
{
  "name": "update_channel",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "attributes": { "subscriber_count": 600000, "open_rate": 0.42 }
  }
}

archive_channel

Soft-delete a channel.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesChannel ID

Example

json
{
  "name": "archive_channel",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

restore_channel

Restore an archived channel.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesChannel ID

Example

json
{
  "name": "restore_channel",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}