Skip to content
emsaemsa

Create Template

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

Create a new document template.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateTemplateRequest
object
name
required
Name
string
>= 1 characters <= 200 characters
description
Description
string
"" <= 1000 characters
org_id
Any of:
string
deal_type
Deal Type
string
"" <= 100 characters
asset_type
Asset Type
string
"" <= 100 characters
section_schema
Section Schema
object
key
additional properties
object
key
additional properties
any
section_order
Section Order
Array<string>
is_default
Is Default
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
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": {}
    }
  ]
}