v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Process

Processes.update

Modifies Process or Processes with given id(s)

patch/entities/Processes/{id}

Path parameters

idstring uuid required

ID of Process to update

Query parameters

validation-levelinteger

Specify validation level of Process on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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://graphql.api-doc.pipelinersales.com/latest/graphql/space/processschema.doc.html

type1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Personal, 2 - Space

Example request

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

Response

Modification confirmation. Returns resulting Process

successboolean

True when response 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
  }
}