Channel routes: update, delete

Reference for Channel, one group of Channel routes.

Channel.update

Changes the given properties of a Channel. Verb page.

Text

PATCH /{namespace}/channels/{id}

Path: id. Body, as JSON: the other inputs. 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

Terminal

curl -X PATCH https://api.sb/leaseline.app/channels/channel_EQ8se34AOW \
  -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.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Channel.delete

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