v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Process

ProcessTemplates.update

Modifies ProcessTemplate or ProcessTemplates with given id(s)

patch/entities/ProcessTemplates/{id}

Path parameters

idstring uuid required

ID of ProcessTemplate to update

Query parameters

validation-levelinteger

Specify validation level of ProcessTemplate 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 of what the template does.

is_recommendedboolean

True when the platform recommends this template (highlighted in the template gallery).

namestring

Name of the entity and its default text representation.

settingsobject

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

Example request

{
  "description": "string",
  "name": "string"
}

Response

Modification confirmation. Returns resulting ProcessTemplate

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",
    "name": "string",
    "action_types": [
      "ArchiveRecord"
    ]
  }
}