DKBSignDocs

API reference

PUTRequires Bearer token

Update a workflow

/api/workflows/update/{workflow}

Initiator or company admin. Changing client_id or model_id after launch returns 409 WORKFLOW_STRUCTURE_LOCKED.

Path parameters

FieldTypeDescription
workflow
Required
stringPath parameter workflow.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
name
stringWorkflow name.
description
stringDescription.
client_id
integerClient id (locked after launch).
model_id
integerModel id (locked after launch).

Responses

StatusMeaning
200Updated
401Missing or invalid Bearer token.

Request

curl
curl -X PUT 'https://api.dkbsigns.com/api/workflows/update/workflow' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"example","description":"example","client_id":1,"model_id":1}'

Response 200

json
{
  "message": "Workflow updated successfully",
  "workflow": {
    "id": 88,
    "name": "Contract ACME",
    "status": "in_progress",
    "model_id": 3,
    "client_id": 12
  }
}