Skip to content
emsaemsa

Save IP deal terms

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

Save or update IP deal terms.

Accepts a JSON body with IPDealTerms fields.

Phase 4: RequireEditor — editors and owners can save IP terms.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
deal_id
required
Deal Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
IPTermsSaveBody

Request body for PUT /ip/terms.

Per-field validation (allowed keys, stripping unknowns, type coercion) runs downstream in validate_ip_terms_payload. The RootModel wrapper enforces that the body parses as a JSON object — FastAPI emits the standard 422 envelope for non-objects, replacing a previous defensive isinstance(body, dict) branch.

object
key
additional properties
any
Examplegenerated
{}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
IPTermsSaveResponse

Response for IP deal terms save.

object
success
required
Success
boolean
error
Any of:
string
stripped_fields
Any of:
Array
Examplegenerated
{
  "success": true,
  "error": "example",
  "stripped_fields": [
    "example"
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}