Message routes: update, delete

Reference for Message, one group of Message routes.

Message.update

Changes the given properties of a Message. Verb page.

Text

PATCH /{namespace}/messages/{id}

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/messages/message_3Dg8ysSOyQ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"medium":"email"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "message": {
    "$id": "https://api.sb/leaseline.app/messages/message_3Dg8ysSOyQ",
    "$type": "Message",
    "medium": "email",
    "direction": "inbound",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Message.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Message.delete

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