CREATE
Create a new QR code theme that will be associated with the given customer API key
CREATE
POST
https://api.eyelevel.ai/v1/partner/theme/qr/:apiKey
Path Parameters
Name | Type | Description |
---|---|---|
apiKey | string | EyeLevel customer key |
Request Body
Name | Type | Description |
---|---|---|
qrTheme | object | See request definition below |
Request
name
REQUIRED - String
Validation: 20 character limit
The human readable name for the QR code theme.
background
OPTIONAL - String
Validation: A valid hex color code
The background color of the QR code. We highly recommend a lighter color so that the QR code can more easily be detected by phone cameras.
foreground
OPTIONAL - String
Validation: A valid hex color code
The foreground color of the QR code. We highly recommend a darker color so that the QR code can more easily be detected by phone cameras.
hasBorder
OPTIONAL - Boolean
Setting this attribute true will add a margin around the edges of the QR code with the background color. The default value is false.
imageUrl
OPTIONAL - String
Validation: A valid URL including protocol http(s)
The URL for the hosted image. This image will be applied to the center of the QR code.
textIdentifier
OPTIONAL - String
Validation: 255 character limit
A human readable string that is displayed below the QR code.
Response
Objects
pageQR THEMELast updated