Comments

API Endpoints for Comments

List Resource Comments
Add Comment To Resource
Retrieve Comment
Update Comment
Delete Comment

List Resource Comments get

https://relatecrm.example.com/api/{resource}/{resourceId}/comments

Headers Required headers


Content-Type (Required)	`string`	application/json
Accept (Required)	`string`	application/json
Authorization (Required)	`string`	Bearer {token}

Path Parameters


resource (Required)	`string`	Any of `['activities', 'calls', 'notes']`
resourceId (Required)	`integer`	Resource record ID

Add Comment To Resource post

https://relatecrm.example.com/api/{resource}/{resourceId}/comments

Headers Required headers


Content-Type (Required)	`string`	application/json
Accept (Required)	`string`	application/json
Authorization (Required)	`string`	Bearer {token}

Path Parameters


resource (Required)	`string`	Any of `['activities', 'calls', 'notes']`
resourceId (Required)	`integer`	Resource record ID

Body Parameters


body (Required)	`string`
via_resource (Optional)	`string`	Required if resource is any of `['notes','calls']` Any of `['contacts', 'companies', 'deals']`
via_resource_id (Optional)	`integer`	Required if resource is any of `['notes','calls']`

Retrieve Comment get

https://relatecrm.example.com/api/comments/{id}

Headers Required headers


Content-Type (Required)	`string`	application/json
Accept (Required)	`string`	application/json
Authorization (Required)	`string`	Bearer {token}

Path Parameters


id (Required)	`integer`	The ID of the record

Update Comment put

https://relatecrm.example.com/api/comments/{id}

Headers Required headers


Content-Type (Required)	`string`	application/json
Accept (Required)	`string`	application/json
Authorization (Required)	`string`	Bearer {token}

Path Parameters


id (Required)	`integer`	The ID of the record

Body Parameters


body (Required)	`string`
via_resource (Optional)	`string`	Required if resource is any of `['notes','calls']` Any of `['contacts', 'companies', 'deals']`
via_resource_id (Optional)	`integer`	Required if resource is any of `['notes','calls']`

Delete Comment delete

https://relatecrm.example.com/api/comments/{id}

Headers Required headers


Content-Type (Required)	`string`	application/json
Accept (Required)	`string`	application/json
Authorization (Required)	`string`	Bearer {token}

Path Parameters


id (Required)	`integer`	The ID of the record