comments

4 endpoints at a glance

Method	Path	Summary
GET	/comments	List Comments
POST	/comments	Create Comment
DELETE	/comments/{comment_id}	Delete Comment
PATCH	/comments/{comment_id}	Update Comment

comments

---

List Comments

GET

/comments

Parameters

Header Parameters

authorization

Query Parameters

entity_type*

Type

string

Required

Valid values

"task""project""contact""event""company""deal"

entity_id*

Type

string

Required

page

Type

integer

Default

1

limit

Type

integer

Default

50

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/comments

Playground

Headers

authorization

Variables

Key

Value

entity_type*

entity_id*

page

limit

Samples

---

Create Comment

POST

/comments

Parameters

Header Parameters

authorization

Request Body

application/json

{

  

"entity_type": "string",

  

"entity_id": "string",

  

"body": "string",

  

"mentions": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/comments

Playground

Headers

authorization

Body

Samples

---

Delete Comment

DELETE

/comments/{comment_id}

Parameters

Header Parameters

authorization

Path Parameters

comment_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/comments/{comment_id}

Playground

Headers

authorization

Variables

Key

Value

comment_id*

Samples

---

Update Comment

PATCH

/comments/{comment_id}

Parameters

Header Parameters

authorization

Path Parameters

comment_id*

Type

string

Required

Request Body

application/json

{

  

"body": "string",

  

"mentions": [

  

  

"string"

  

]

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/comments/{comment_id}

Playground

Headers

authorization

Variables

Key

Value

comment_id*

Body

Samples

---