updateRunItem

PATCH

/update-runs/{runId}/items/{accountId}

const url = 'http://localhost:8080/api/v1/update-runs/per_01j9x3k8m2q4r5s6t7v8w9y0z1/items/per_01j9x3k8m2q4r5s6t7v8w9y0z1';
const options = {
  method: 'PATCH',
  headers: {cookie: 'hs_session=<hs_session>', 'Content-Type': 'application/json'},
  body: '{"status":"opening","captureId":"per_01j9x3k8m2q4r5s6t7v8w9y0z1","detail":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url http://localhost:8080/api/v1/update-runs/per_01j9x3k8m2q4r5s6t7v8w9y0z1/items/per_01j9x3k8m2q4r5s6t7v8w9y0z1 \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "status": "opening", "captureId": "per_01j9x3k8m2q4r5s6t7v8w9y0z1", "detail": "example" }'

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

runId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

accountId

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

Request Body^required

application/json

object

status

required

string

Allowed values: opening capturing uploaded skipped failed

captureId

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

detail

string

<= 200 characters

Responses

204

Saved.

updateRunItem

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Responses

204

Request Body^required