Create a conversation comment

POST/v1/conversations/{convID}/comments

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

convIDstringrequired

Conversation ID

Request body

requiredapplication/json

contentstringrequired

mentionsConversationCommentMention[] | null

Show properties

Array of ConversationCommentMention

user_idstringrequired

user_namestringrequired

Responses

200OK

contentstringrequired

conversation_idstringrequired

created_atstringrequired

created_bystringrequired

created_by_namestringrequired

idstringrequired

mentionsConversationCommentMention[] | nullrequired

Show properties

Array of ConversationCommentMention

user_idstringrequired

user_namestringrequired

organization_idstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/conversations/string/comments" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "mentions": [
    {
      "user_id": "string",
      "user_name": "string"
    }
  ]
}'

const response = await fetch("/v1/conversations/string/comments", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "content": "string",
  "mentions": [
    {
      "user_id": "string",
      "user_name": "string"
    }
  ]
})
});

import requests

response = requests.post(
    "/v1/conversations/string/comments",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "content": "string",
  "mentions": [
    {
      "user_id": "string",
      "user_name": "string"
    }
  ]
},
)

Response

{
  "content": "string",
  "conversation_id": "string",
  "created_at": "string",
  "created_by": "string",
  "created_by_name": "string",
  "id": "string",
  "mentions": [
    {
      "user_id": "string",
      "user_name": "string"
    }
  ],
  "organization_id": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}