Skip to content
em sa em sa

Rename Deal

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

Rename a deal’s display name.

Updates the deal name across all Redis-backed stores (queue entry, deal mapping, canvas session). Does NOT affect pinecone_namespace, store_deal_id, report_id, or any immutable identifiers.

Phase 4: RequireEditor — editors and owners can rename deals.

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
RenameDealRequest

Request body for renaming a deal.

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
RenameDealResponse

Response for PATCH /api/canvas/{deal_id}/name.

object
success
required
Success
boolean
deal_id
required
Deal Id
string
deal_name
required
Deal Name
string
Example generated
{
  "success": true,
  "deal_id": "example",
  "deal_name": "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": {}
    }
  ]
}