Codes

Rename, re-point or re-organise a code

A request that says nothing is refused rather than answered with a 200 that changed nothing. A payload naming a different type than the code has is refused too.

Only a dynamic code can be re-pointed: a static code carries its destination inside the printed pattern.

Removing a GS1 Digital Link (gs1: null) accepts an optional confirm query parameter, checked when it is sent: the code's name or its short link ending.

patch/api/v1/codes/{id}

Request

  • Base URL: https://app.qrsalt.com
  • URL: https://app.qrsalt.com/api/v1/codes/{id}
  • Auth: HTTP bearer

Query parameters

confirmstring

Optional. When sent it must be the code's name or its short link ending, or the request is refused.

Request body

namestring
destinationstring
payloadobject
notestring

What the destination history records. Defaults to "Changed via API".

domainstring nullable

Move the short link to a verified domain of this workspace, or back to ours with null. The old domain stops serving the code.

slugstring

The custom link on the code's domain; a blank string puts it back to the short code.

folderIdstring nullable
tagsstring[]
status'ACTIVE' | 'PAUSED'

Response

The code.

metaobject required

Changes

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