Process

Processes.update

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

patch/entities/Processes/{id}

Request

Path parameters

idstring uuid required

Id of the Process record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

ai_conversationobject

AI assistant conversation associated with the process (e.g. records of AI-driven schema generation).

descriptionstring

Free-text description shown alongside the process.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the owning user.

settingsobject

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).

type1 | 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

Example request

{
  "description": "string",
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "type": 1
}

Response

The changed Process record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "description": "string",
    "last_schema_change": "2019-01-01T00:00:00",
    "last_status_change": "2019-01-01T00:00:00",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.