Update a code

Rename, refile, retag, archive, or change where the code points. Fields left out stay as they are.

Authorization

apiKey

AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Path Parameters

id*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 120

destination?||

folderId?string|null

tags?array<>

Itemsitems <= 20

utm?|

null removes the campaign parameters.

gps?boolean

webhookUrl?|

null removes the webhook.

Formaturi

Lengthlength <= 500

accessCode?|

A value sets or replaces the access code, null removes it.

Lengthlength <= 64

logo?||

A logo sets or replaces the centre logo, null removes it. The artwork is re-rendered.

colors?array<>

Recolour the artwork: its distinct colours, code first and frame last, are swapped one for one for these. The ink must still read against the background. The artwork is re-rendered.

Items1 <= items <= 8

shape?string

Round or squared outline for the code and its frame.

Value in

"circle"
"square"

tweaks?

archived?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/codes/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "shortCode": "string",  "name": "string",  "scanUrl": "string",  "destination": {    "type": "string",    "url": "string",    "pageId": "string",    "fallbackUrl": "string",    "rules": [      {        "name": "string",        "url": "http://example.com",        "conditions": [          {            "type": "time",            "operator": "before",            "value": "string",            "valueEnd": "string"          }        ],        "joins": [          "and"        ]      }    ],    "summary": "string"  },  "folderId": "string",  "tags": [    "string"  ],  "archived": true,  "hasAccessCode": true,  "previewUrl": "string",  "scans": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "design": {    "kind": "auto",    "archetype": "string",    "palette": [      "string"    ],    "scanVerified": true  },  "warnings": [    "string"  ]}

Update a code

AuthorizationCopiar link a esta sección

Path ParametersCopiar link a esta sección

Request BodyCopiar link a esta sección

Response BodyCopiar link a esta sección

200application/json

400application/json

403application/json

404application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`