Skip to main content
POST
/
v1
/
comments
cURL
curl --request POST \
  --url https://platform.thena.ai/v1/comments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "content": "<string>",
  "contentHtml": "<string>",
  "contentJson": "<string>",
  "threadName": "<string>",
  "entityType": "<string>",
  "entityId": "<string>",
  "parentCommentId": "<string>",
  "commentVisibility": "<string>",
  "commentType": "<string>",
  "metadata": {},
  "attachmentIds": [
    "<string>"
  ],
  "commentAs": "<string>",
  "customerEmail": "<string>",
  "deDuplicationKey": "<string>"
}'
{
  "id": "<string>",
  "content": "<string>",
  "contentHtml": "<string>",
  "contentJson": "<string>",
  "contentMarkdown": "<string>",
  "isEdited": true,
  "threadName": "<string>",
  "commentVisibility": "<string>",
  "commentType": "<string>",
  "isPinned": true,
  "sourceEmailId": "<string>",
  "metadata": {},
  "parentCommentId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "author": "<string>",
  "authorId": "<string>",
  "authorUserType": "<string>",
  "customerContactId": "<string>",
  "customerContactEmail": "<string>",
  "customerContactFirstName": "<string>",
  "customerContactLastName": "<string>",
  "customerContactAvatarUrl": "<string>",
  "authorAvatarUrl": "<string>",
  "impersonatedUserEmail": "<string>",
  "impersonatedUserName": "<string>",
  "impersonatedUserAvatar": "<string>",
  "attachments": [
    "<string>"
  ],
  "deletedAt": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key

Body

application/json
​
entityType
string
required

The type of the entity

​
entityId
string
required

The identifier of the entity

​
content
string

The content of the comment

​
contentHtml
string

The HTML content of the comment

​
contentJson
string

The JSON content of the comment

​
threadName
string

The name of the comment thread

​
parentCommentId
string

The parent comment ID

​
commentVisibility
string

The visibility of the comment

​
commentType
string

The type of the comment

​
metadata
object

The metadata of the comment

​
attachmentIds
string[]

The attachment IDs

​
commentAs
string

The comment as a string

​
customerEmail
string

The customer contact's email address

​
deDuplicationKey
string

A deduplication key provided by an external application. The platform uses this key to prevent the creation of duplicate comments.

Maximum length: 255

Response

Operation successful

​
id
string
required

The unique identifier of the comment

​
content
string
required

The content of the comment

​
contentHtml
string
required

The HTML content of the comment

​
contentJson
string
required

The JSON content of the comment

​
contentMarkdown
string
required

The markdown content of the comment

​
isEdited
boolean
required

Indicates if the comment is edited

​
threadName
string
required

The name of the comment thread

​
commentVisibility
string
required

The visibility of the comment

​
commentType
string
required

The type of the comment

​
isPinned
boolean
required

Indicates if the comment is pinned

​
sourceEmailId
string
required

The source email ID of the comment

​
metadata
object
required

The metadata of the comment

​
parentCommentId
string
required

The parent comment ID of the comment

​
createdAt
string
required

The creation date of the comment

​
updatedAt
string
required

The update date of the comment

​
author
string
required

The author of the comment

​
authorId
string
required

The unique identifier of the author of the comment

​
authorUserType
string
required

The user type of the author of the comment

​
customerContactId
string
required

The customer contact ID of the author of the comment

​
customerContactEmail
string
required

The email of the customer contact of the author of the comment

​
customerContactFirstName
string
required

The first name of the customer contact of the author of the comment

​
customerContactLastName
string
required

The last name of the customer contact of the author of the comment

​
customerContactAvatarUrl
string
required

The avatar url of the customer contact of the author of the comment

​
authorAvatarUrl
string
required

The avatar url of the author of the comment

​
impersonatedUserEmail
string
required

The impersonated user email

​
impersonatedUserName
string
required

The impersonated user name

​
impersonatedUserAvatar
string
required

The impersonated user avatar

​
attachments
string[]
required

The attachments of the comment

​
deletedAt
string
required

The deletion date of the comment (null if not deleted)

⌘I