Skip to content

by Startups.Studio

Channel.create

POST /{namespace}/channels

Creates a Channel.

Noun: Channel
Mode: do
Event: Channel.created

You, to your agent

Add a channel to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/channels \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email"}'

import { $ } from 'startup-builder'

const channel = await $.Channel.create({ medium: 'email' })

npx startup-builder do Channel.create --json '{"medium":"email"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Channel.create({ medium: 'email' })"
  }
}

Create makes a new Channel from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`medium`	`string`	required	The platform type, such as `email`, `sms`, or `chat`.
`organization`	Organization		The outside Organization the Channel is shared with; its new Messages open Conversations for that Customer.
`external`	`boolean`		True when people from another Organization post in it, as in a channel two companies share.
`areaCode`	`string`		For an `sms` Channel, the phone area code its number is drawn from, such as `512`.
`number`	`string`		For an `sms` Channel, its phone number in international form, assigned when it is created.

Outputs

Output	Type	Required	Description
`channel`	Channel	required	The Channel.

Effects

Emits Channel.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Channel.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Channel

Previous Page

Channel.delete

Next Page