Update

Update Step by ID

PATCH https://biometridon.polygon.pt/api/steps/:id

This endpoint allows you to update a step by id.

Path Parameters

Name	Type	Description
id	string	ID of the step to get

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Authentication user token

Request Body

Name	Type	Description
description	string
label	string	Unique label
type	string	type available: form
settings	object	Settings object
required	boolean
clientId	string	Client id (Master User)
forAllClients	boolean	Availability (Master User)

200

{
  "data": {
    "label": "Step 1",
    "aliasId": "STEP_1",
    "type": "form",
    "settings": {
      "fields": [
        {
          "type": "text",
          "aliasId": "fieldtest1",
          "label": "Test field 1",
          "editable": false,
          "rules": [
            {
              "type": "required"
            }
          ]
        }
      ]
    },
    "required": null,
    "clientId": "5f06dd360d2a954da80c098f",
    "forAllClients": null,
    "active": true,
    "created_at": "2020-07-10T13:52:43.905Z",
    "updated_at": "2020-07-10T13:52:43.905Z",
    "id": "5f0872abae1e08524034ec65"
  },
  "meta": {
    "message": "Step Updated with success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Step not found",
    "code": "4001"
  },
  "status": false
}

// Example

{
	"label": "Step 1",
	"aliasId": "step_1",
	"type": "form",
	"settings": {
		"fields": [
			{
				"type": "text",
				"aliasId": "fieldtest1",
				"label": "Test field 1",
				"editable": false,
				"rules": [
					{
						"type": "required"
					}
				]
			}
		]
	}
}