Create a message

Create a message

Request Body — REQUIRED
integrationId string
integrationUrl string
channel string Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK]
title string — REQUIRED Possible values: 1 ≤ length ≤ 1000
content string — REQUIRED Possible values: 1 ≤ length ≤ 500000
labels string[]
requester object — REQUIRED Requester to be upserted. This field accepts multiple identifier fields (ordered by priority: externalUid, email, name). If no customer is not found using the first identifier, the next one is used, and so on until the last identifier is reached. If no customer if found after reaching the last field, a new customer is created. If a customer is found using one identifier, and additional identifiers are provided but not defined upstream, this customer will be updated with the provided identifiers. type string — REQUIRED Possible values: [USER, COMPANY] externalUid string This value is used to uniquely identify a customer in an external system. email string Email identifier is only used for users (type: USER). name string — REQUIRED Name is always required. If your intention is to uniquely identify a customer with other identifiers than name, you may replicate the aforementioned field into the name field.
submitter object Submitter to be upserted. See requester for more details. If the submitter is not provided and requester type is USER, the requester will be used as submitter. externalUid string This value is used to uniquely identify a customer in an external system. email string Email identifier is only used for users (type: USER). name string — REQUIRED Name is always required. If your intention is to uniquely identify a customer with other identifiers than name, you may replicate the aforementioned field into the name field.

Responses

201 Create a single message Schema — OPTIONAL message object id string clientId string receivedAt date-time — OPTIONAL createdAt date-time updatedAt date-time 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 content string channel string Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK] read boolean updated boolean archived boolean bin boolean assigneeId string — OPTIONAL requesterId string submitterId string labels string[] code number messageStatus string