DKBSignDocs

API reference

PUTRequires Bearer token

Update a model step

/api/workflows/models/{model}/steps/update/{step}

Update /api/workflows/models/{model}/steps/update/{step}. Authenticated routes need Authorization: Bearer {token} from POST /api/v1/login.

Path parameters

FieldTypeDescription
model
Required
stringPath parameter model.
step
Required
stringPath parameter step.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
name
stringStep name.
description
stringDescription.
users
arrayCandidate user ids.
roles
arrayCandidate role ids.
type
stringunidirectionnel or conditionnel.
e.g. "unidirectionnel"
actions
array[{ "libelle": "Valider", "action": "validate" }].

Responses

StatusMeaning
200Success
401Missing or invalid Bearer token.

Request

curl
curl -X PUT 'https://api.dkbsigns.com/api/workflows/models/model/steps/update/step' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"example","description":"example","users":[1],"roles":[1],"type":"unidirectionnel","actions":[{}]}'

Response 200

json
{
  "data": {
    "id": 88,
    "name": "Contract ACME",
    "status": "in_progress",
    "model_id": 3,
    "client_id": 12
  }
}