Codes

Create a code

Send either destination (the shortcut for a URL code) or payload (the structured content for its type).

Without kind, a type that can be dynamic is made dynamic and anything else static. A blank string in an optional field means "not set", except in folderId (no folder) and slug (the generated ending), where a blank has always meant something.

post/api/v1/codes

Request

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

Request body

namestring
kind'STATIC' | 'DYNAMIC'

Absent means dynamic if the type can be, static otherwise.

type'URL' | 'TEXT' | 'WIFI' | 'EMAIL' | 'PHONE' | 'SMS' | 'VCARD' | 'GS1' | 'PDF' | 'LANDING' | 'APP_STORE' | 'REVIEW' | 'LOCATION' | 'EVENT' | 'PAYMENT' | 'GALLERY' | 'AUDIO'
payloadobject

The content in the shape its type takes, validated by the same payload validator the dashboard uses.

destinationstring

The shortcut for a URL code. Send this or payload.

folderIdstring nullable
output'both' | 'link' | 'qr'

link stores a short link; anything else a QR code. A link on a static type is refused.

slugstring

A chosen ending, on domain or on ours. Which plans may choose one is enforced by the service.

domainstring nullable

A verified hostname of this workspace. Absent: the workspace default. Null: our own domain.

tagsstring[]
status'ACTIVE' | 'PAUSED'

Response

The code that was made.

metaobject required

Changes

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