Comment on an entity

POST

comments

curl --request POST \
  --url https://platform.thena.ai/v1/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "content": "<string>",
  "contentHtml": "<string>",
  "threadName": "<string>",
  "entityType": "<string>",
  "entityId": "<string>",
  "parentCommentId": "<string>",
  "commentVisibility": "<string>",
  "commentType": "<string>",
  "metadata": {},
  "attachmentUrls": [
    "<string>"
  ],
  "commentAs": "<string>",
  "customerEmail": "<string>"
}'

{
  "id": "<string>",
  "content": "<string>",
  "contentHtml": "<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>",
  "authorAvatarUrl": "<string>",
  "attachments": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Enter JWT bearer token

x-org-id

string

header

required

Enter organization ID

Body

application/json

content

string

required

The content of the comment

entityType

string

required

The type of the entity

entityId

string

required

The identifier of the entity

contentHtml

string

The HTML 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

attachmentUrls

string[]

The attachment URLs

commentAs

string

The comment as a string

customerEmail

string

The customer contact's email address

Response

201

application/json

Operation successful

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

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

authorAvatarUrl

string

required

The avatar url of the author of the comment

attachments

string[]

required

The attachments of the comment

Search tickets

Get comments on an entity

curl --request POST \
  --url https://platform.thena.ai/v1/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-org-id: <api-key>' \
  --data '{
  "content": "<string>",
  "contentHtml": "<string>",
  "threadName": "<string>",
  "entityType": "<string>",
  "entityId": "<string>",
  "parentCommentId": "<string>",
  "commentVisibility": "<string>",
  "commentType": "<string>",
  "metadata": {},
  "attachmentUrls": [
    "<string>"
  ],
  "commentAs": "<string>",
  "customerEmail": "<string>"
}'

{
  "id": "<string>",
  "content": "<string>",
  "contentHtml": "<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>",
  "authorAvatarUrl": "<string>",
  "attachments": [
    "<string>"
  ]
}

Introduction

Authorizations

Body

Response