Skip to content
em sa em sa

Batch Resolve Comments

POST
/api/canvas/{deal_id}/comments/batch-resolve
 
curl --request POST \
  --url https://example.com/api/canvas/example/comments/batch-resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "comment_ids": [ "example" ], "section_key": "example" }'

Resolve multiple comments in one request.

If section_key is provided without comment_ids, resolves ALL unresolved comments on that section. Otherwise uses provided comment_ids.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
BatchResolveRequest

Request to resolve multiple comments at once.

object
comment_ids
Any of:
Array<string>
section_key
Any of:
string
Example generated
{
  "comment_ids": [
    "example"
  ],
  "section_key": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
BatchResolveResponse
object
results
required
Results
Array<object>
BatchResolveResult
object
comment_id
required
Comment Id
string
success
required
Success
boolean
error
Any of:
string
all_success
required
All Success
boolean
resolved_count
required
Resolved Count
integer
Example generated
{
  "results": [
    {
      "comment_id": "example",
      "success": true,
      "error": "example"
    }
  ],
  "all_success": true,
  "resolved_count": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}