Skip to content
em sa em sa

Batch Save Sections

PUT
/api/canvas/{deal_id}/sections/batch
 
curl --request PUT \
  --url https://example.com/api/canvas/example/sections/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sections": [ { "content": "...", "section_key": "executive_summary" }, { "content": "...", "section_key": "financial_analysis" } ] }'

Save multiple sections in a single request.

Each section is transitioned to ‘reviewed’ state with the provided content. Transitions are independent - partial failures are reported per-section.

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
BatchSaveRequest

Request body for batch section save.

object
sections
required
Sections
Array<object>
BatchSectionUpdate

A single section update in a batch request.

object
section_key
required
Section Key
string
content
required
Content
string
Example 
{
  "content": "Updated executive summary content...",
  "section_key": "executive_summary"
}
Example 
{
  "sections": [
    {
      "content": "...",
      "section_key": "executive_summary"
    },
    {
      "content": "...",
      "section_key": "financial_analysis"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
BatchSaveResponse

Response for batch section save.

object
results
required
Results
Array<object>
BatchSectionResult

Result for a single section in a batch operation.

object
section_key
required
Section Key
string
success
required
Success
boolean
error
Any of:
string
all_success
required
All Success
boolean
Example generated
{
  "results": [
    {
      "section_key": "example",
      "success": true,
      "error": "example"
    }
  ],
  "all_success": 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": {}
    }
  ]
}