Skip to content
em sa em sa

Invalidate Canvas

DELETE
/api/canvas/{deal_id}
 
curl --request DELETE \
  --url https://example.com/api/canvas/example \
  --header 'Authorization: Bearer <token>'

Invalidate (delete) a canvas session.

Phase 4: RequireOwner — only deal owners can destroy the session.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
InvalidateCanvasResponse

Response for DELETE /api/canvas/{deal_id}.

object
success
required
Success
boolean
message
required
Message
string
Example generated
{
  "success": true,
  "message": "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": {}
    }
  ]
}