Skip to main content
POST
/
threads
/
messages
Quick send message
curl --request POST \
  --url https://inboxapp.com/api/v1/threads/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountLinkId": "<string>",
  "content": "<string>",
  "externalPlatformId": "<string>",
  "externalId": "<string>"
}
'
{
  "message": {
    "platform": "twitter",
    "teamId": "<string>",
    "threadId": "<string>",
    "id": "<string>",
    "userId": "df6jbw4h36...",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "platformId": "1234567890",
    "content": "<string>",
    "campaignId": "df6jbw4h36...",
    "authorId": "<string>",
    "origin": "internal",
    "replyData": "<unknown>",
    "forwardData": "<unknown>",
    "entities": "<unknown>",
    "attachment": "<unknown>",
    "reactions": [
      "<unknown>"
    ],
    "isEncrypted": true,
    "isEdited": true,
    "deletedAt": "2023-11-07T05:31:56Z",
    "platformDeletedAt": "2023-11-07T05:31:56Z"
  },
  "thread": {
    "id": "<string>",
    "platformId": "<string>"
  }
}
Sending to a prospect who hasn’t messaged you first (outbound) requires the Outbound Messages addon ($199/mo). Replying to existing conversations works on all plans. See Working with messages for details.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
accountLinkId
string
required

The account link ID to send the message from.

Pattern: ^[0-9a-z]+$
Example:

"df6jbw4h36..."

​
content
string
required
Minimum string length: 1
Example:

"Hey, I'm reaching out from Acme Agency..."

​
externalPlatformId
string

The platform ID of the prospect. Must be provided if externalId is not provided.

Example:

"1234567890"

​
externalId
string

The Inbox external ID of the prospect. Must be provided if externalPlatformId is not provided.

Example:

"1234567890"

Response

200 - application/json

OK

​
message
object
required
​
thread
object
required