Create message with the Intercom API

Sends a new message from a teammate to a contact, in the Messenger (in_app) or by email. Email needs subject and template. The conversation only exists after the contact replies, unless create_conversation_without_contact_reply is true.

Identifier
intercom_create_message

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "message_type": "in_app",
    "body": "<body>",
    "from": {},
    "to": {}
  }
}

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
message_typestringYesin_app shows the message in the Messenger; email sends it by email.Values: in_app, email
subjectstringNoSubject of the email. Required with email.
bodystringYesContent of the message, as HTML or plain text.
templatestringNoStyle of the email, plain or personal. Required with email.
fromobjectYesThe teammate who sends the message.
toobjectYesThe contact who receives the message.
create_conversation_without_contact_replybooleanNotrue opens the conversation in the inbox right away, without waiting for the contact to reply. The default is false.

Supported connections

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

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/intercom, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

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/intercom_create_message. It becomes your agent's tool definition with no conversion.

Other Intercom 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.