πŸ–‡οΈComments

API Endpoints for Comments

List Resource Comments GET

Endpoint: https://subdomain.appcrm.com.br/api/{resource}/{resourceId}/comments

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

Endpoint: https://subdomain.appcrm.com.br/api/{resource}/{resourceId}/comments

Hearders

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

Endpoint: https://subdomain.appcrm.com.br/api/comments/{id}

Headers

Content-Type

Required

string

application/json

Accept

Required

string

application/json

Authorization

Required

string

Bearer {token}

Path

id

Required

integer

The ID of the record

Update Comment PUT

Endpoint: https://subdomain.appcrm.com.br/api/comments/{id}

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

Endpoint: https://subdomain.appcrm.com.br/api/comments/{id}

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

Last updated

Was this helpful?