---
title: "ProcessTemplates.update"
method: PATCH
path: "/entities/ProcessTemplates/{id}"
tags: ["Process"]
---

# ProcessTemplates.update

`PATCH /entities/ProcessTemplates/{id}`

Modifies ProcessTemplate or ProcessTemplates with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateProcessTemplateInput
  - `description` string — Free-text description of what the template does.
  - `is_recommended` boolean — True when the platform recommends this template (highlighted in the template gallery).
  - `name` string — Name of the entity and its default text representation.
  - `settings` object — Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html
  - `documents` object[] — Files attached to the template (e.g. reference documents, screenshots).
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting ProcessTemplate

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ProcessTemplate
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `description` string — Free-text description of what the template does.
    - `is_recommended` boolean — True when the platform recommends this template (highlighted in the template gallery).
    - `name` string, required — Name of the entity and its default text representation.
    - `settings` object, required — Process schema shipped by the template, as a JSON object conforming to the ProcessSchema type (trigger, nodes, settings). Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html
    - `documents` string[] — Files attached to the template (e.g. reference documents, screenshots).
    - `action_types` string[] — Action-type icons present in the template schema, used for filtering templates by capability (e.g. SendEmail, CreateRecord, Webhook).

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)