flows

Adding/Updating flow Notes

You need flow.edit permission to access this resource

patch/flows/{flow_id}/notes

Request

  • Base URL: https://api.elastic.io/v2
  • URL: https://api.elastic.io/v2/flows/{flow_id}/notes
  • Auth: HTTP basic

Path parameters

flow_idstring required

Flow identifier

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "attributes": {
      "note": "<h1>Title</h1>"
    }
  }
}

Response

OK

metaobject required

Example response

{
  "data": {
    "data": {
      "id": "5b4f337bff4304610483ba67",
      "attributes": {
        "note": "<h1>Title</h1>",
        "flow_id": "5b4f337bff4304610483ba67"
      },
      "relationships": {
        "flow": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          }
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.