Channel methods: update, delete

Reference for Channel, one group of Channel methods.

Channel.update

Changes the given properties of a Channel. Verb page.

TypeScript

interface ChannelVerbs {
  update(input: ChannelUpdateInput, options?: SB.CallOptions): SB.Call<Channel>
}

Emits Channel.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Channel.
`medium`	`string`		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.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const channel = await $.Channel.update({ id: 'channel_EQ8se34AOW', medium: 'email' })

Deletes a Channel: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface ChannelVerbs {
  delete(input: ChannelDeleteInput, options?: SB.CallOptions): SB.Call<Channel>
}

Emits Channel.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Channel.

Returns

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

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.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const channel = await $.Channel.delete({ id: 'channel_EQ8se34AOW' })