Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

Update an existing flow based on the specified identifier.

Info

NOTE: You cannot add datasets to the flow through this endpoint. Moving pre-existing datasets into a flow is not supported in this release. Create the flow first and then when you create the datasets, associate them with the flow at the time of creation.


Version:
v3

Required Permissions

The authenticated user must be an admin.

D s api auth

Request

Request Type: PATCH

Endpoint:

Code Block
/v3/flows/<id>
ParameterDescription
<id>Internal identifier of the flow to update.

Request URI - Example:

Code Block
/v3/flows/6

Request Body:

You can modify the following properties. 

Code Block
{
  "name": "My Flow",
  "description": "This is my flow."
}

Response

Response Status Code - Success:  200 - Ok

Response Body Example:

Code Block
{
  "id": 6,
  "updatedBy": 1,
  "updatedAt": "2017-02-17T18:28:47.675Z"
}

Reference

For more information on the properties of a flow, see API Flows Get v3.