Skip to content
em sa em sa

Apply approved ripple changes with SSE progress

POST
/api/canvas/{deal_id}/ripple/apply
 
curl --request POST \
  --url https://example.com/api/canvas/example/ripple/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preview_token": "example", "approved_sections": [ { "section_key": "example", "tier": 1 } ], "include_exec_summary": true }'

Apply previously previewed ripple changes to memo sections.

Returns an SSE stream with per-section progress events, ending with a ripple_done event containing a rollback_token for the undo endpoint.

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
RippleApplyRequest

Request body for applying approved ripple changes.

object
preview_token
required
Preview Token

Token from the preview response

string
approved_sections
required
Approved Sections

Sections to update, with their approved tier

Array<object>
ApprovedSection
object
section_key
required
Section Key
string
tier
required
Tier
integer
>= 1 <= 4
include_exec_summary
Include Exec Summary

Whether to regenerate executive summary (if recommended)

boolean
default: true

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