Skip to content

Update template

PUT
/v2/document/template/{templateId}

Updates a template based on the provided data, then returns the newly updated template version

templateId
required
string

The ID of the template

Example
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
X-API-Key
string

API Key

X-API-Secret
string

API Secret

object
templateId
required

The Template Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
name
required

The Template Name

string
Japanese Invoice
description

The Template Description

string
Template used for extract data from japanese invoices received in Australia.
type
required

The Template Type

string
Invoice
tag
required

The Template Tag

string
Invoice
providerModelId

The Provider Model Id (see document/models)

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
prompts
required

A prompt array of strings

Array<object>
object
id
required

A prompt Id

string
a1b2c3d4-5678-4e2a-9c1a-2b3c4d5e6f7a
name
required

A prompt name

string
Summary
fieldType
required

A field type

string
text
format
required

A format

string
string
description
required

A description

string
Whats the summary of the document?
itemType

An item type

string
string
children
Array<object> recursive

The resource has been successfully updated.

object
templateVersionId

The Version Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
templateId

The Template Id

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
version

The Template Version

number
5
name

The Template Name

string
Japanese Invoice
description

The Template Description

string
Template used for extract data from japanese invoices received in Australia.
type

The Template Type

string
Invoice
tag

The Template Tag

string
Invoice
providerModelId

The Provider Model Id (see document/models)

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a