Skip to content
em sa em sa

Approve Section

POST
/api/canvas/{deal_id}/sections/{section_key}/approve
 
curl --request POST \
  --url https://example.com/api/canvas/example/sections/example/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "comment": "example", "role": "example", "quality_score": 1, "conditions": [ "example" ], "force": false }'

Approve a section of the memo.

Phase 4: RequireEditor — editors and owners can approve sections.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string
section_key
required
Section Key
string

Request Body required

Section titled “Request Body required ”
Media type application/json
ApproveRequest
object
comment
Any of:
string
<= 500 characters
role
Any of:
string
/^(analyst|partner|reviewer)$/
quality_score
Any of:
integer
>= 1 <= 5
conditions
Any of:
Array<string>
<= 3 items
force
Force

Owner-only: bypass unresolved comment gate

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ApprovalResponse
object
section_key
required
Section Key
string
approved_by
required
Approved By
string
approved_at
required
Approved At
string
comment
Any of:
string
role
Any of:
string
quality_score
Any of:
integer
conditions
Conditions
Array<object>
ConditionStatusEntry

One approval condition with resolution state. Mirrors src/canvas/models/section_approval.ConditionStatus.to_dict().

object
text
required
Text
string
resolved
Resolved
boolean
resolved_by
Any of:
string
resolved_at
Any of:
string
all_conditions_resolved
All Conditions Resolved
boolean
default: true
notifications_delivered
Notifications Delivered
boolean
default: true
auto_promoted
Any of:
boolean
Example 
{
  "conditions": [
    {
      "resolved": false
    }
  ],
  "all_conditions_resolved": true,
  "notifications_delivered": true
}

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