Skip to main content
PUT
/
modules
/
{module_id}
Update Module
curl --request PUT \
  --url https://api.docketqa.com/modules/{module_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "title": "<string>",
  "viewport_width": 123,
  "viewport_height": 123,
  "browser_zoom": 123,
  "steps": [
    {
      "step_number": 123,
      "type": "<string>",
      "action": "<string>",
      "use_vision": true
    }
  ]
}
'
{
  "message": "<string>",
  "module": {
    "id": 123,
    "title": "<string>",
    "type": "<string>",
    "status": "<string>",
    "test_steps": [
      {}
    ],
    "test_blueprints_using_module": [
      {}
    ],
    "company_id": 123,
    "browser_zoom": 123,
    "viewport_width": 123,
    "viewport_height": 123,
    "usage_count": 123,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}
Update an existing module’s title, browser settings, and steps. This replaces all existing steps with the new set provided.
​
module_id
integer
required
The ID of the module to update.
​
title
string
The updated module name.
​
viewport_width
integer
Browser viewport width in pixels.
​
viewport_height
integer
Browser viewport height in pixels.
​
browser_zoom
number
Browser zoom level.
​
steps
object[]
The new set of steps for the module. This replaces all existing steps.

​
Example request body

{
  "title": "Updated Login Module",
  "viewport_width": 1900,
  "viewport_height": 1200,
  "browser_zoom": 1,
  "steps": [
    {
      "step_number": 1,
      "type": "act",
      "action": "Navigate to the updated login page",
      "use_vision": false
    }
  ]
}
​
message
string
A confirmation message (e.g. "Module updated successfully").
​
module
object
The updated module object.

​
Example response

{
  "message": "Module updated successfully",
  "module": {
    "id": 963,
    "title": "Updated Login Module",
    "type": "step_module",
    "status": "active",
    "company_id": 23,
    "browser_zoom": 1.0,
    "viewport_width": 1900,
    "viewport_height": 1200,
    "usage_count": 0,
    "test_blueprints_using_module": [],
    "test_steps": [
      {
        "id": 23108,
        "step_number": 1,
        "type": "act",
        "action": "Navigate to the updated login page",
        "use_vision": false,
        "api_request": null
      }
    ],
    "created_at": "2025-12-13T18:56:48.692214+00:00",
    "updated_at": "2025-12-13T20:00:51.903151+00:00"
  }
}
Updating a module replaces all existing steps with the steps provided in the request body. Make sure to include all steps you want to keep.