/v1/channel-connections (POST)

POST

/v1/channel-connections

const url = 'http://localhost:8787/v1/channel-connections';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"channel":"ical","feedUrl":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8787/v1/channel-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "channel": "ical", "feedUrl": "https://example.com" }'

Authorizations

ApiKeyAuth

Request Body

application/json

object

channel

required

string

Allowed values: ical

feedUrl

required

string format: uri

Responses

201

Created status: 'active' immediately — the /15 * * * import fan-out picks it up on the next cron tick. Map at least one resource via POST /v1/channel-connections/{id}/listings before that’s useful (docs/06: an unmapped connection has nowhere to write blocks).

application/json

object

channel

required

string

Allowed values: ical

createdAt

required

string

feedUrl

required

string

required

string format: uuid

status

required

string

Allowed values: pending active error disabled

Example

{
  "channel": "ical",
  "status": "pending"
}

404

No API key context resolved for this request.

application/problem+json

object

code

required

string

Allowed values: resource_not_found feed_token_not_found connection_not_found listing_already_mapped conflict_not_found invalid_cursor already_resolved

detail

required

string

status

required

number

title

required

string

type

required

string

Example

{
  "code": "resource_not_found"
}