Skip to main content

Create a message

Create a message

Request Body REQUIRED
integrationId string

Integration ID

integrationUrl string

Integration URL

channel string

Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK, MS_TEAMS, PUBLIC_API, HFC, AIRCALL, CLAAP, GONG, MODJO, PRAIZ]

Message channel

title string REQUIRED

Possible values: 1 ≤ length ≤ 1000

Message title

content string REQUIRED

Possible values: 1 ≤ length ≤ 500000

Message content

labels string[]

Message labels

requester object REQUIRED

Requester to be upserted

type string REQUIRED

Possible values: [USER, COMPANY]

Customer type (USER or COMPANY)

externalUid string

External unique identifier for the customer

email string

Email identifier (only for type: USER)

name string REQUIRED

Customer name (always required)

submitter object

Submitter to be upserted (optional)

externalUid string

External unique identifier for the company

email string

Company email

name string REQUIRED

Company name (always required)

Responses
201

Create a single message

Schema OPTIONAL
message object

The created message data

id string

Unique identifier of the message

clientId string

Client identifier

receivedAt date-time OPTIONAL

Date when the message was received

createdAt date-time

Creation date of the message

updatedAt date-time

Last update date of the message

integrationUrl string OPTIONAL

When you import messages from an external source (e.g.: Intercom) into Harvestr, this is the URL of the message in the source tool

integrationId string OPTIONAL

When you import messages from an external source (e.g.: Intercom) into Harvestr, this is the message ID in the source tool

title string

Title of the message

content string

Content of the message

channel string

Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK, MS_TEAMS, PUBLIC_API, HFC, AIRCALL, CLAAP, GONG, MODJO, PRAIZ]

Channel through which the message was received

read boolean

Whether the message has been read

updated boolean

Whether the message has been updated

archived boolean

Whether the message is archived

bin boolean

Whether the message is in the bin

assigneeId string OPTIONAL

Identifier of the assignee

requesterId string

Identifier of the requester

submitterId string

Identifier of the submitter

labels string[]

Labels associated with this message