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

# Processes.update

`PATCH /entities/Processes/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Processes/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Processes/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Changes fields of the Process record with the given id; fields left out keep their values.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateProcessInput: Field values to change on a Process record; fields left out keep their values.
  - `ai_conversation` object: AI assistant conversation associated with the process (e.g. records of AI-driven schema generation).
  - `description` string: Free-text description shown alongside the process.
  - `name` string: Name of the entity and its default text representation.
  - `owner_id` string, uuid: Id of the owning user.
  - `settings` object: Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema (see the linked schema).
  - `type` 1 | 2: Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. Integer enum value: 1 - Personal, 2 - Space
  - `tags` object[]: Tags attached to the process for organisation/filtering.
    - `id` string, uuid: Id of the related TagRelation record.
  - `documents` object[]: Files attached to the process (e.g. process documentation).
    - `id` string, uuid: Id of the related CloudObjectRelation record.

## Response `200`

The changed Process record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Process: Automatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook).
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `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.
    - `owner` string, uri, required: User who owns the process. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields.
    - `ai_conversation` object: AI assistant conversation associated with the process (e.g. records of AI-driven schema generation).
    - `deactivation_reason` 0 | 1 | 2 | 3: Why the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only. Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 - DisabledFeature
    - `description` string: Free-text description shown alongside the process.
    - `is_enabled` boolean: When true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations.
    - `last_schema_change` string, date-time: Timestamp of the most recent change to settings.
    - `last_status_change` string, date-time: Timestamp of the most recent change to is_enabled.
    - `name` string, required: Name of the entity and its default text representation.
    - `owner_id` string, uuid, required: Id of the owning user.
    - `settings` object: Process schema as a JSON object conforming to the ProcessSchema type — trigger, nodes and settings. Built via the process builder; validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/p/#ProcessSchema This payload conforms to the `ProcessSchema` JSON Schema (see the linked schema).
    - `type` 1 | 2, required: Scope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space. Integer enum value: 1 - Personal, 2 - Space
    - `activity_logs` string[]: Activity log runs (one per process execution) recorded for this process.
    - `tags` string[]: Tags attached to the process for organisation/filtering.
    - `activity` object, required: Activity timeline for the last 24 hours showing per-hour counts of successful, warning, and error process runs.
    - `documents` string[]: Files attached to the process (e.g. process documentation).

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)