Skip to content
em sa em sa

Create Suggestion

POST
/api/canvas/{deal_id}/suggestions
 
curl --request POST \
  --url https://example.com/api/canvas/example/suggestions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "section_key": "example", "suggestion_id": "example", "original_text": "example", "proposed_text": "example", "anchor_text": "example" }'

Create a user-authored edit suggestion.

RequireCommenter — commenters, editors, and owners can propose changes. No edit lock required (suggestions don’t mutate canonical content).

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
CreateSuggestionRequest
object
section_key
required
Section Key
string
>= 1 characters
suggestion_id
required
Suggestion Id
string
>= 1 characters <= 64 characters
original_text
required
Original Text
string
<= 5000 characters
proposed_text
required
Proposed Text
string
<= 5000 characters
anchor_text
Any of:
string
<= 500 characters
Example generated
{
  "section_key": "example",
  "suggestion_id": "example",
  "original_text": "example",
  "proposed_text": "example",
  "anchor_text": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
example

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": {}
    }
  ]
}