v1

latestOpenAPI 3.1.02026-07-241050242.7 KB

Add System Confirmation Message

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

post/inboxApps/{inboxAppId}/systemMessage

Path parameters

inboxAppIdstring required

The Inbox App ID adding the message.

Request body

externalConversationIdstring required

A unique identifier that references this conversation.

externalMessageIdstring required

A unique identifier that references this message.

messagestring required

A plaintext message body.

type'success' | 'info' | 'error'

The system confirmation message type.

Response

201

idinteger

createdstring

updatedstring

sentAtstring

{"stackTrail":"paths:/inboxApps/{inboxAppId}/systemMessage:post:responses:201:content:application/json:schema:properties:deliveryStatus","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/inboxApps/{inboxAppId}/systemMessage:post:responses:201:content:application/json:schema:properties:deliveryStatusErrorMessage","oasType":"schema","type":"unknown"}

createdByIdinteger

updatedByIdinteger

isIncomingboolean

messagestring

isSystemboolean

systemTypestring

userIdinteger

personIdinteger

attachmentsobject[]

conversationDeepLinkUrlstring

Example response

{
  "id": 1,
  "created": "2024-01-01T12:00:00Z",
  "updated": "2024-01-01T12:00:00Z",
  "sentAt": "2024-01-01T12:00:00Z",
  "createdById": 1,
  "updatedById": 1,
  "isIncoming": true,
  "message": "An example system confirmation message.",
  "isSystem": true,
  "systemType": "success",
  "personId": 1,
  "sender": {
    "personId": 1,
    "name": "John Doe"
  },
  "conversationDeepLinkUrl": "https://app.followupboss.com/2/inbox-new/0/inbox/1"
}