Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

recipes

Creates Flows from a Recipe based on the specified Recipe Id and starts them immediately

You need workspaces.flow.edit permission to access this resource

If the Recipe contains a Component, which requires a Credential, it should be provided among the request payload.

post/recipes/{recipe_id}/activate

Path parameters

recipe_idstring required

Recipe identifier

Request body

Example request

{
  "data": {
    "relationships": {
      "workspace": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        }
      }
    }
  }
}

Response

Created

Example response

{
  "data": {
    "relationships": {
      "flow": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ]
      },
      "recipe_deployment": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        }
      }
    }
  }
}