Skip to main content
POST
/
messages
/
{messageId}
/
forward
JavaScript
import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: process.env['NUNTLY_API_KEY'], // This is the default and can be omitted
});

const response = await client.messages.forward('imsg_01kabn43yqyxn2bx4ve84mczd3', {
  to: ['dev@stainless.com'],
});

console.log(response.id);
{
  "data": {
    "id": "<string>",
    "threadId": "<string>",
    "messageId": "<string>",
    "subject": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Path Parameters

​
messageId
string
required

The id of the message

Example:

"imsg_01kabn43yqyxn2bx4ve84mczd3"

Body

application/json

Forward recipients and optional message comment.

​
to
string<email>[]
required

The recipient addresses to forward to.

Minimum array length: 1

The email address.

​
text
string

An optional comment to prepend.

Response

Successful response.

​
data
object
required