Send message with the Front API

Sends a new message from a channel, which starts a new conversation, and answers 202 with a message_uid. It goes out right away, and Front archives the new conversation unless options.archive is false. Needs the send permission on the API token.

Identifier
front_send_message

The request

POST https://connect.reportei.com/api/tools/front_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "channel_id": "<channel_id>",
    "to": [],
    "body": "<body>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
channel_idstringYesChannel that sends the message: the id starting with cha_ from List channels, or alt:address: followed by the channel address, like alt:address:support@acme.com.
toarrayYesRecipient handles, like email addresses or phone numbers, depending on the channel.
bodystringYesBody of the message. Email channels accept HTML.
ccarrayNoHandles that get a copy.
bccarrayNoHandles that get a blind copy.
subjectstringNoSubject, for email messages.
author_idstringNoId of the teammate the message is sent on behalf of, starting with tea_, from List teammates.
optionsobjectNoTags to add and whether to archive the new conversation after sending.

Supported connections

Your customer connects their Front account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/front_send_message. It becomes your agent's tool definition with no conversion.

Other Front tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.