Skip to content
em sa em sa

Create Blank Deal

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

Create a new blank canvas document.

Generates a UUID deal_id, seeds a canvas session with a starter H1 heading, and registers the deal in the user’s queue so it appears in the Deal Room. The is_blank flag on the session tells the editor to apply first-impression polish (watermark boost, entry animation, tip callout) without waiting for pipeline content.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
CreateBlankDealRequest

Request body for creating a blank canvas document.

object
deal_name
required
Deal Name
string
>= 1 characters <= 200 characters
Example generated
{
  "deal_name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
CreateBlankDealResponse

Response for blank deal creation.

object
deal_id
required
Deal Id
string
redirect_url
required
Redirect Url
string
Example generated
{
  "deal_id": "example",
  "redirect_url": "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": {}
    }
  ]
}