Skip to content
em sa em sa

Update Template

PATCH
/api/canvas/templates/{template_id}
 
curl --request PATCH \
  --url https://example.com/api/canvas/templates/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "deal_type": "example", "asset_type": "example", "section_schema": { "additionalProperty": {} }, "section_order": [ "example" ], "is_default": true, "category": "example", "tags": [ "example" ] }'

Update a template (creator only).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
template_id
required
Template Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
UpdateTemplateRequest
object
name
Any of:
string
>= 1 characters <= 200 characters
description
Any of:
string
<= 1000 characters
deal_type
Any of:
string
<= 100 characters
asset_type
Any of:
string
<= 100 characters
section_schema
Any of:
object
key
additional properties
object
key
additional properties
any
section_order
Any of:
Array<string>
is_default
Any of:
boolean
category
Any of:
string
<= 100 characters
tags
Any of:
Array<string>
Example generated
{
  "name": "example",
  "description": "example",
  "deal_type": "example",
  "asset_type": "example",
  "section_schema": {
    "additionalProperty": {}
  },
  "section_order": [
    "example"
  ],
  "is_default": true,
  "category": "example",
  "tags": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Example generated
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": {}
    }
  ]
}