• Features
  • Pricing
Get Started

List TemplatesCreate TemplateGet TemplateUpdate TemplateDelete Template

PATCH /v1/templates/{templateId}

Partially update a template with a JSON request body.

PATCH /v1/templates/{templateId} updates an existing template.

Authentication

Send an organization API key in x-api-key or Authorization: Bearer <key>.

Path Parameters

NameTypeDescription
templateIdstring (uuid)UUID of the template to update.

Request Body

Send a JSON object containing at least one of the following fields.

NameTypeDescription
namestringTemplate name, from 1 to 255 characters.
descriptionstring or nullShort template description, up to 1,000 characters. Send null to clear it.
authorstring (uuid) or nullMember ID of the template author.
labelIdsarray of strings (uuid)Labels assigned to the template.
activebooleanWhether the template can be used to create documents.
contentarrayStructured template content.
metadataarrayTemplate metadata and field definitions.

Example

curl -X PATCH "https://api.blueputto.com/v1/templates/TEMPLATE_ID" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"active":false}'

Success Response

200 OK

{
  "data": {}
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 429 Too Many Requests

GET /v1/templates/{templateId}

Retrieve a single template by its UUID.

DELETE /v1/templates/{templateId}

Delete a template.

On this page

AuthenticationPath ParametersRequest BodyExampleSuccess ResponseError Responses