Message methods: update, delete

Reference for Message, one group of Message methods.

Message.update

Changes the given properties of a Message. Verb page.

TypeScript

interface MessageVerbs {
  update(input: MessageUpdateInput, options?: SB.CallOptions): SB.Call<Message>
}

Emits Message.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Message.
`medium`	`string`		One of `email`, `sms`, `voice`, or `chat`.
`direction`	`string`		One of `inbound` or `outbound`.
`body`	`text`		What it says.
`from`	`string`		The sender: an address, a number, or a Channel id.
`to`	`string`		The recipient: an address, a number, or a Person id.
`subject`	`string`		The subject line, for email.
`purpose`	`string`		Why it goes out, such as onboarding; consent and suppression rules read it.

Returns

Output	Type	Required	Description
`message`	Message	required	The Message.

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 message = await $.Message.update({ id: 'message_3Dg8ysSOyQ', medium: 'email' })

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

TypeScript

interface MessageVerbs {
  delete(input: MessageDeleteInput, options?: SB.CallOptions): SB.Call<Message>
}

Emits Message.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`message`	Message	required	The Message.

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 message = await $.Message.delete({ id: 'message_3Dg8ysSOyQ' })