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

• HTTPBearer

Parameters

Path Parameters

deal_id

required

Deal Id

string

section_key

required

Section Key

string

Request Body^required

Media typeapplication/json

ApproveRequest

object

comment

Any of:

string

string

<= 500 characters

null

null

role

Any of:

string

string

/^(analyst|partner|reviewer)$/

null

null

quality_score

Any of:

integer

integer

>= 1 <= 5

null

null

conditions

Any of:

Array<string>

Array<string>

<= 3 items

null

null

force

Force

Owner-only: bypass unresolved comment gate

boolean

Responses

200

Successful Response

Media typeapplication/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

string

null

null

role

Any of:

string

string

null

null

quality_score

Any of:

integer

integer

null

null

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

string

null

null

resolved_at

Any of:

string

string

null

null

all_conditions_resolved

All Conditions Resolved

boolean

default: true

notifications_delivered

Notifications Delivered

boolean

default: true

auto_promoted

Any of:

boolean

boolean

null

null

bear_acknowledgement_required

Bear Acknowledgement Required

boolean

bear_message

Any of:

string

string

null

null

Example

{
  "conditions": [
    {
      "resolved": false
    }
  ],
  "all_conditions_resolved": true,
  "notifications_delivered": true,
  "bear_acknowledgement_required": false
}

422

Validation Error

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