Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server error
404 Not found

Examples

PUT /api/recipes/1
{
  "name": "Send mail",
  "code": "{\"number\":0,\"provider\":\"clock\",\"name\":\"timer\",\"as\":\"timer\",\"keyword\":\"trigger\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{\"interval\":\"5\",\"start_at\":\"\"},\"block\":[{\"number\":1,\"provider\":\"email\",\"name\":\"send_mail\",\"as\":\"send_mail\",\"keyword\":\"action\",\"dynamicPickListSelection\":{},\"toggleCfg\":{},\"input\":{},\"uuid\":\"cd865246-ece7-4188-845e-33d021664be3\"}],\"uuid\":\"c4b0778d-5a23-4c52-a5bb-4a99ae5d25ae\"}",
  "config": "[{\"keyword\":\"application\",\"name\":\"clock\",\"provider\":\"clock\"},{\"keyword\":\"application\",\"name\":\"email\",\"provider\":\"email\"}]"
}
200
{
  "success": true
}
PUT /api/recipes/2

200
{
  "success": false,
  "errors": {
    "running": [
      "can't modify running recipe"
    ]
  }
}

Params

Param name Description
id
required

Recipe ID

Validations:

  • Must be a number.

recipe
optional

Validations:

  • Must be a Hash

recipe[name]
optional

Name of the recipe

Validations:

  • Must be String

recipe[code]
optional

JSON string representing the recipe lines

Validations:

  • Must be String

recipe[config]
optional

JSON string representing the connection lines

Validations:

  • Must be String