DKBSignDocs

API reference

POSTRequires Bearer token

Create a model step

/api/workflows/models/{model}/steps/create

type is unidirectionnel or conditionnel. users / roles / actions may be JSON strings.

Path parameters

FieldTypeDescription
model
Required
stringPath parameter model.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
name
Required
stringStep name, unique per model.
e.g. "Legal review"
description
stringDescription.
users
Required
arrayCandidate user ids.
e.g. [4,5]
roles
arrayCandidate role ids.
type
Required
stringunidirectionnel or conditionnel.
e.g. "unidirectionnel"
actions
arrayOptional [{ "libelle": "Signer", "action": "sign" }].

Responses

StatusMeaning
201Step created
401Missing or invalid Bearer token.

Request

curl
curl -X POST 'https://api.dkbsigns.com/api/workflows/models/model/steps/create' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Legal review","users":[4,5],"type":"unidirectionnel"}'

Response 201

json
{
  "message": "Enregistrement effectué",
  "workflowStep": {
    "id": 7,
    "name": "Legal review"
  }
}