Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthChannel

Channel routes: create, get, list

The Channel Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Channel, one group of Channel routes.

Channel.create

Creates a Channel. Verb page.

Text
POST /{namespace}/channels

Body, as JSON: the inputs. Emits Channel.created.

Inputs

InputTypeRequiredDescription
mediumstringrequiredThe platform type, such as email, sms, or chat.
organizationOrganizationThe outside Organization the Channel is shared with; its new Messages open Conversations for that Customer.
externalbooleanTrue when people from another Organization post in it, as in a channel two companies share.
areaCodestringFor an sms Channel, the phone area code its number is drawn from, such as 512.
numberstringFor an sms Channel, its phone number in international form, assigned when it is created.

Returns

OutputTypeRequiredDescription
channelChannelrequiredThe Channel.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/channels \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "channel": {
    "$id": "https://api.sb/leaseline.app/channels/channel_EQ8se34AOW",
    "$type": "Channel",
    "medium": "email"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Channel.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Channel.get

Returns one Channel by id. Verb page.

Text
GET /{namespace}/channels/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Channel.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
channelChannelrequiredThe Channel.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/channels/channel_EQ8se34AOW \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Channel",
  "$id": "https://api.sb/leaseline.app/channels/channel_EQ8se34AOW",
  "channel": {
    "$id": "https://api.sb/leaseline.app/channels/channel_EQ8se34AOW",
    "$type": "Channel",
    "medium": "email"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/channels/channel_EQ8se34AOW",
    "up": "https://api.sb/leaseline.app/channels"
  }
}

Channel.list

Returns Channels, newest first, one page at a time. Verb page.

Text
GET /{namespace}/channels

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
channelslist of ChannelrequiredOne page of Channels.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/channels?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Channel",
  "channels": [
    {
      "$id": "https://api.sb/leaseline.app/channels/channel_EQ8se34AOW",
      "$type": "Channel",
      "medium": "email"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "channel_EQ8se34AOW"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/channels?limit=20",
    "next": "https://api.sb/leaseline.app/channels?after=channel_EQ8se34AOW"
  }
}

Channel

Previous

update, delete

Next