Update a template

PATCH 
/v1/documents/templates/:id

update a template.

Request

Path Parameters

id stringrequired

application/json

Body

name string

Possible values: <= 255 characters

The template name

slug string

Possible values: <= 255 characters

The template slug

template string

The template content

active boolean

Default value: true

disable template flag.

description string

Possible values: <= 255 characters

The template description

metadata

object

The template metadata

property name* any

The template metadata

options

object

The template rendering options

property name* any

The template rendering options

related_object string

Possible values: [shipment, order, other]

Default value: other

The template related object

Responses

200

application/json

Schema

Schema

id string

A unique identifier

name stringrequired

Possible values: <= 255 characters

The template name

slug stringrequired

Possible values: <= 255 characters

The template slug

template stringrequired

The template content

active boolean

Default value: true

disable template flag.

description string

Possible values: <= 255 characters

The template description

metadata

object

The template metadata

property name* any

The template metadata

options

object

The template rendering options

property name* any

The template rendering options

related_object string

Possible values: [shipment, order, other]

Default value: other

The template related object

object_type string

Default value: document-template

Specifies the object type

Example (from schema)

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "template": "string",
  "active": true,
  "description": "string",
  "metadata": {},
  "options": {},
  "related_object": "other",
  "object_type": "document-template"
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

404

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...