Steps

Update step

Changed on

Updates an existing step

patch/api/v1/steps/{id}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/steps/{id}
  • Auth: none declared

Path parameters

idstring required

Request body

action'click' | 'input' | 'navigation' | 'keypress'

The browser interaction type captured for the step

action_textstring nullable
notesstring nullable
target_elementobject nullable
type'interaction' | 'canvas'

The browser interaction type captured for the step

urlstring nullable

Response

OK

Example response

{
  "step": {
    "guide_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "media_assets": [
      {
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "step_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      }
    ]
  }
}

Changes

  • a294b480da05Revision changes
    • warning

      added the new keypress enum value to the ///// response property for the response status

    • info

      added the new keypress enum value to the request property