Update Workflow
The Update Workflow API endpoint allows you to modify an existing workflow within your organisation by updating its name, description, and connections. This ensures workflows remain relevant and aligned with organisational needs. By using this endpoint, you can seamlessly manage changes while maintaining consistency and operational efficiency across teams. It’s a valuable tool for keeping workflows up-to-date and optimised as requirements evolve.
Syntax: see 'CCall Structure
Type = 'POST'
| 'https://connect.cambrionix.com/api/workflows/v1/workflows/workflow-id' \ |
| Output | Description |
|---|---|
| workflow-id | This is the id of the workflow as a unique 128-bit number |
In the data section of the request, include the workflow information you wish to add, formatted as shown below.
|
{ "name": "workflow-name", "description": "workflow-description", "events": "string", "connections": [ { "id": "unique-connection-id", "from": { "id": "unique-event-id" }, "to": { "id": "unique-event-id" } } ], "enabled": option-status } |
| Output | Description |
|---|---|
| workflow-name | This is the name of the workflow |
| workflow-description | This is a description of the workflow |
| unique-connection-id | This is the id of a unique connection as a unique 128-bit number |
| unique-event-id | This is the id of a unique event as a unique 128-bit number |
| option-status | The status of the option (true/false) |
Returns:
|
{ "name": "workflow-name", "description": "workflow-description", "events": "string", "connections": [ { "id": "unique-connection-id", "type": "connection-type", "from": { "id": "unique-event-id" }, "to": { "id": "unique-event-id" } } ], "enabled": option-status, "published": option-status, "organization": { "id": "organisation-id", "name": "organisation-name" } } |
| Output | Description |
|---|---|
| workflow-name | This is the name of the workflow |
| workflow-description | This is a description of the workflow |
| unique-connection-id | This is the id of a unique connection as a unique 128-bit number |
| connection-type | This is the type of connection e.g. success |
| unique-event-id | This is the id of a unique event as a unique 128-bit number |
| option-status | The status of the option (true/false) |
| organisation-id | This is the id of the organisation as a unique 128-bit number |
| organisation-name | This is the name of the organisation |
Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned