PUT /api/v1/workflows/{workflowId} — Update Workflow
The "Update Workflow" API method enables modification of an existing workflow instance. This method is essential for altering workflow details and destinations.
Authentication
SadqAuthorize
Request Headers
- Authorization (required)
- Bearer {token}
- Content-Type (required)
- application/json
Path Parameters
- workflowId (string, required)
- The unique workflow ID
Request Body
Content-Type: application/json
- Id (GUID, required)
- The unique identifier (GUID) of the workflow to be updated.
- NameAr (string, required)
- The new Arabic name of the workflow.
- NameEn (string, required)
- The new English name of the workflow.
- IsActive (string, required)
- A boolean value indicating whether the workflow is to be active.
- IsDeleted (string, required)
- A boolean value indicating whether the workflow is to be marked as deleted.
- WorkflowDestinations (array, required)
- An array of destination objects to be updated.
{
"Id": "",
"NameAr": "",
"NameEn": "",
"IsActive": true,
"IsDeleted": false,
"WorkflowDestinations": [
{
"Id": "",
"WorkflowId": "",
"Name": "",
"Email": "",
"Phone": "",
"Order": 1,
"AuthenticationType": 1,
"DestinationType": 3
},
{
"Id": "",
"WorkflowId": "",
"Name": "",
"Email": "",
"Phone": "",
"Order": 2,
"AuthenticationType": 1,
"DestinationType": 3
}
]
}Responses
HTTP 200 — Workflow updated
{
"errorCode": 0,
"message": null,
"returnUrl": "/dashboard",
"stateValidationErrors": null,
"signature": ""
}