Update

Update Flow by ID

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

This endpoint allows you to update a flow by id.

Path Parameters

Name	Type	Description
id	string	ID of the flow to get

Headers

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

Request Body

Name	Type	Description
childFlowId	string	required if stepsOrdered have step type multiusers
name	string	Unique name
stepsOrdered	array	List of step ids
settingsId	string	Flow settings id
clientId	string	Client id (Master User)
forAllClients	boolean	Availability (Master User)

200

{
  "data": {
    "name": "flow 1",
    "stepsOrdered": [
      "5f06dd39a89fd30bd4671862"
    ],
    "settingsId": "5f06dd3c198040265c1fc732",
    "clientId": "5f06dd360d2a954da80c098f",
    "active": true,
    "created_at": "2020-07-10T10:51:20.599Z",
    "updated_at": "2020-07-10T10:51:20.599Z",
    "id": "5f084828ed1bb82d64ee7b44"
  },
  "meta": {
    "message": "Flow updated with success."
  },
  "status": true
}

404

{
  "data": {},
  "meta": {
    "message": "Flow not found",
    "code": "4002"
  },
  "status": false
}

409 Flow settings not active

{
  "data": {},
  "meta": {
    "message": "Resource not active",
    "code": "5001"
  },
  "status": false
}

POST https://biometridon.polygon.pt/api/flows

Request Body

Name	Type	Description
childFlowId	string

200

// Example

{
	"name": "flow 1",
	"stepsOrdered": [
		"5f06dd39a89fd30bd4671862"
	],
	"settingsId": "5f06dd3c198040265c1fc732",
	"clientId": "5f06dd360d2a954da80c098f",
	"forAllClients": true
}