Add Message

post

https://api.followupboss.com/v1/inboxApps/{inboxAppId}/message

Adds a message to an existing or new Inbox App conversation.

Path Params

inboxAppId

string

required

The Inbox App ID adding the message.

Body Params

externalConversationId

string

required

A unique identifier that references this conversation.

externalMessageId

string

required

A unique identifier that references this message.

replyToExternalMessageId

string

If this message is a reply to a previous message, specify the external message ID of the message being replied to.

sentAt

date

The timestamp the message was delivered at in ISO8601 UTC format. Defaults to current time if omitted.

subject

string

Sets or updates the subject of the conversation.

message

string

required

A plaintext message body.

isIncoming

boolean

required

Indicates if the message was incoming to your system.

sender

object

required

Who sent the message. Can be a FUB User, a FUB Person, or an unrelated entity such as an AI bot.

isAutomation

boolean

Defaults to false

Whether the sender is an automated system. Defaults to false.

person

object

The person associated with the conversation. A Person ID is preferred, but name, email, and/or phone are acceptable if the person does not exist in FUB yet. Required on the first message in a conversation.

owner

object

The owner of the conversation. Can be a FUB User or FUB Team Inbox. Required on the first message in a conversation.

deliveryStatus

string

enum

The message's delivery status.

Allowed:

deliveryStatusErrorMessage

string

Optional user-facing error message for Not Delivered statuses.

attachments

array of objects

attachments

richObjects

array of strings

List of Rich Object URLs.

richObjects

Responses

201201

400400