Skip to content
FSCO Docs

Update template

PUT
/v2/document/template/{templateId}

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
templateId
required
string

The ID of the template

Example
88f39775-01f6-43ef-b553-08410c588116

Header Parameters

Section titled “Header Parameters ”
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Request Body required

Section titled “Request Body required ”
object
templateId
required

The Template Id

string
88f39775-01f6-43ef-b553-08410c588116
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
88f39775-01f6-43ef-b553-08410c588116
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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource has been successfully updated.

object
templateVersionId

A unique template Version Id

string
88f39775-01f6-43ef-b553-08410c588116
templateId

A template Id grouped on version

string
88f39775-01f6-43ef-b553-08410c588116
version

The Template Version

number
1
name

A template name

string
JapaneseInvoice
description

A template description

string
Used for extract all documents from the japanese providers.
type

Type of template, usually associated with the type of document, but you can set your own classification

string
invoice
tag

Identifies your templates in the dashboard UI

string
customer-template
prompts

Group of prompts or properties to be extracted or analyzed from the document

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
providerModel

The provider model

object