Update flow metadata only

Update the unversioned metadata of an existing flow

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the flow to update

Body Params

The flow metadata fields to update

string

Workspace Id

int64

Time the test was created in epoch milliseconds

int64

Time the test was last updated in epoch milliseconds

string

The ID of the user who last updated this test

string
length ≤ 50

Unique identifier

string

The ID of the user who created this test

boolean

Shares the browser state this flow produces with the rest of a cloud plan run.

Tests that reach the flow before any state has been stored each run it and store
their own result. The tests in a plan stage start together, so that is the common
case; a test that starts once state already exists for the same application and
credentials begins from that stored state instead.

To sign in once per plan run, put a test that runs this flow in an earlier plan
stage, against the same application URL and with the same credentials. Stages run
in order, so the tests of later stages all start from the state that test stored.

A marked flow still runs every time. It is not skipped, so it must decide for
itself whether there is anything left to do — a login flow, for example, should
wrap its sign-in steps in a condition that only holds when the login page is
actually showing. A marked flow that unconditionally repeats its work will do so
on a browser that already carries the session.

The stored state lasts only for the plan run. Has no effect on local CLI runs.

string

Version of the import tool used to import this flow

string
enum

Type of flow

string
enum

The mobile platform associated with this object

Allowed:
boolean

When enabled, mabl will not capture screenshots, network logs, DOM snapshots,
or other test artifacts in order to report the most accurate flow execution time

string

The display name of the flow. Required (non-blank) for reusable flows.
When absent on older reusable data, the API serves the description value
here; non-reusable flows are never given a name they did not have.

string

Usage notes and considerations for the flow. Historically this field held
the flow's display name; that role has moved to name. To rename a flow,
write name — writing this field edits the description only. When a flow
has no description, the API serves the flow's name here for backwards
compatibility.

labels
array of objects

User provided labels

labels
string
enum

Framework the flow was imported from

Allowed:
Headers
string

If-Match header according to http/1.1 spec section 14.24

Responses

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json