QR Campaigns

Create QR code

Creates a dynamic QR campaign definition. Requires site.manage_data.

post/api/sites/{id}/qr-codes

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/qr-codes
  • Auth: API key in cookie hk_token

Path parameters

idstring uuid required

Request body

custom_paramsobject
destination_urlstring uri required
namestring required
styleobject
utm_campaignstring
utm_contentstring
utm_mediumstring
utm_sourcestring
utm_termstring

Response

Created QR code

archived_atstring date-time
created_atstring date-time
created_bystring uuid
custom_paramsobject
destination_urlstring uri
has_assetboolean
idstring uuid
namestring
redirect_urlstring uri

Dynamic HitKeep redirect URL to encode in printed QR assets.

site_idstring uuid
styleobject
token_hintstring
updated_atstring date-time
utm_campaignstring
utm_contentstring
utm_mediumstring
utm_sourcestring
utm_termstring

Changes

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