Skip to main content
PUT
/
api
/
process
/
{id}
Updates an existing workflow process and synchronizes field removals across all containers.
curl --request PUT \
  --url https://{install}/api/process/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "fields": [
    {
      "fieldId": "<string>",
      "order": 123,
      "required": true
    }
  ],
  "features": [
    "<string>"
  ],
  "workflow": [
    {
      "id": "<string>",
      "fieldId": "<string>",
      "value": "<string>",
      "next": "<string>",
      "userGroup": [
        "<string>"
      ]
    }
  ],
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

​
id
string
required

The unique identifier of the process to update.

Body

The updated process configuration.

​
entity
null | string
​
name
string
​
description
string
​
image
string
​
fields
object[]
​
features
string[]
​
workflow
object[]
​
tenantId
string
​
id
string
​
created
string<date-time>
​
createdBy
string
​
updated
string<date-time>
​
updatedBy
string
​
deleted
boolean

Response

Process updated and containers synchronized.