Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Approval

ApprovalProcesses.update

Modifies ApprovalProcess or ApprovalProcesses with given id(s)

patch/entities/ApprovalProcesses/{id}

Path parameters

idstring uuid required

ID of ApprovalProcess to update

Query parameters

validation-levelinteger

Specify validation level of ApprovalProcess 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

descriptionstring

Free-text description shown alongside the approval process.

is_enabledboolean

When true, the approval process actively raises approvals on matching record events; when false, the process is paused.

last_schema_changestring date-time

Timestamp of the most recent change to settings.

last_status_changestring date-time

Timestamp of the most recent change to is_enabled.

namestring

Name of the entity and its default text representation.

owner_idstring uuid

Id of the owning user.

settingsobject

Approval process schema as a JSON object conforming to the ApprovalProcessSchema type — trigger, filter, approver settings, and approve/reject nodes. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/approvalprocessschema.doc.html

Example request

{
  "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"
}

Response

Modification confirmation. Returns resulting ApprovalProcess

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",
    "entity_type": 1,
    "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",
    "priority": 1
  }
}