latestSwagger 2.0Apache 2.02026-08-0824630.2 KB

4f44976989c8

ScheduledCapture

Update an existing scheduled capture

put/scheduledcapture/{id}

Path parameters

idstring uuid required

ID of scheduled capture to update

Request body

idstring uuid required

namestring required

pausedboolean required

commentstring

createdAtstring

updatedAtstring

Example request

{
  "id": "204347e0-eaf8-11e9-ac83-338a9cee6792",
  "name": "My capture",
  "createdAt": "2019-10-09T02:43:15.281Z",
  "updatedAt": "2019-10-09T02:43:15.281Z",
  "captureRequest": {
    "apps": [
      "204347e0-eaf8-11e9-ac83-338a9cee6792"
    ],
    "browser": "Chrome",
    "country": "USA",
    "emails": [
      "foo@gmail.com"
    ],
    "format": "png",
    "height": 1024,
    "size": "Full Page",
    "steps": [
      {
        "command": "type",
        "selector": "#login-btn",
        "value": "username"
      }
    ],
    "waitSecond": 5,
    "maxWait": 10,
    "hidePopups": 1,
    "dark": 1,
    "strictSSL": 1,
    "width": 1280,
    "zoom": 100
  },
  "schedule": {
    "exactDates": [
      "2020-05-15"
    ],
    "timesOfDay": [
      "17:05"
    ]
  },
  "trackers": [
    {
      "id": "amazon_category_rank",
      "input": "B0BFYM54RF"
    }
  ]
}

Response

Capture updated

integer[] required

Number of captures updated, [0] or [1]

Example response

[
  1
]