Skip to content

Undo previously applied ripple changes

POST
/api/canvas/{deal_id}/ripple/undo
curl --request POST \
--url https://example.com/api/canvas/example/ripple/undo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "rollback_token": "example" }'

Restore sections to their pre-ripple state using a rollback token.

The rollback token expires after 1 hour.

deal_id
required
Deal Id
string
Media type application/json
RippleUndoRequest

Request body for undoing applied ripple changes.

object
rollback_token
required
Rollback Token

Token from the apply response

string
Example generated
{
"rollback_token": "example"
}

Successful Response

Media type application/json
Example generated
example

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