Public API v1

Rename or repoint a code

No idempotency key is required, because a PATCH with an absolute body is already idempotent: applying it twice leaves the same state.

Every destination change is re-screened. That is not optional — a dynamic code that has been printed and trusted is precisely the asset an attacker wants to repoint.

slug, linkId and resolverState are not patchable. The slug is printable and therefore permanent; the other two are platform identity and platform state.

Codes bound to an ordering place are protected server-side, including when a write arrives through an integration. Individual connectors may support fewer payload types than this API.

patch/api/v1/codes/{linkId}

Request

  • Base URL: https://scanduro.com
  • URL: https://scanduro.com/api/v1/codes/{linkId}
  • Auth: HTTP bearer

Request body

namestring
destinationstring
status'active' | 'paused'
designstring
scanCapinteger nullable
payloadstring nullable

Response

Updated.

Example response

{
  "data": {
    "id": "lnk_4f2c19ab7d0e46f1a8b3c5d7e9f10203",
    "hostname": "sisar.scandu.ro"
  }
}

Changes

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