PATCH
/
v1
/
templates
/
{template_id}
curl --request PATCH \
  --url https://api.pardocs.com/v1/templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "document_type": "<string>",
  "template_data": {}
}'
{
  "template_id": "<string>",
  "document_type": "<string>",
  "template_data": {},
  "template_created_at": 123,
  "template_updated_at": 123
}
The Update a Template endpoint allows you to modify an existing template identified by {template_id}. You can update one or more fields of the template schema. Any field that is not provided in the request will remain unchanged.
Note that this process can also be done in the ParDocs Console
Request Body Parameters:
  • document_type (string, optional): Specifies the document type the schema applies to.
  • template_data (object, optional): Contains the updated schema definition for the extraction.
curl --request PATCH \
  --url https://api.pardocs.com/v1/templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "document_type": "<string>",
  "template_data": {}
}'

Authorizations

x-api-key
string
header
required

Path Parameters

template_id
string
required

The ID of template to update.

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.