APIQr code
Create a new QR code
Creates a new QR code based on the provided data. If the QR code is dynamic (contentType = URL and isEditable = true), a short URL is automatically generated, linked to the QR code, and returned in the response. Returns the full QR code object including any related entities.
Authorization
bearerAuth AuthorizationBearer <token>
Enter your API key to access this API
In: header
Request Body
application/json
name*string|null
Length
length <= 32config*
content*|||
[key: string]?never
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://qrcodly.theosirislabs.com/api/v1/qr-code" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "config": { "width": 0, "height": 0, "margin": 0, "imageOptions": { "hideBackgroundDots": true }, "dotsOptions": { "type": "dots", "style": { "type": "hex", "value": "string" } }, "cornersSquareOptions": { "type": "dot", "style": { "type": "hex", "value": "string" } }, "cornersDotOptions": { "type": "dot", "style": { "type": "hex", "value": "string" } }, "backgroundOptions": { "style": { "type": "hex", "value": "string" } } }, "content": { "type": "url", "data": { "url": "http://example.com" } } }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"name": "string",
"config": {
"width": 0,
"height": 0,
"margin": 0,
"image": "string",
"imageOptions": {
"hideBackgroundDots": true
},
"dotsOptions": {
"type": "dots",
"style": {
"type": "hex",
"value": "string"
}
},
"cornersSquareOptions": {
"type": "dot",
"style": {
"type": "hex",
"value": "string"
}
},
"cornersDotOptions": {
"type": "dot",
"style": {
"type": "hex",
"value": "string"
}
},
"backgroundOptions": {
"style": {
"type": "hex",
"value": "string"
}
}
},
"content": {
"type": "url",
"data": {
"url": "http://example.com",
"isEditable": true
}
},
"previewImage": "string",
"createdBy": "string",
"shortUrl": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shortCode": "strin",
"destinationUrl": "http://example.com",
"qrCodeId": "8a619d64-dbe8-4c9d-9490-babe22a53a28",
"isActive": true,
"createdBy": "string"
}
}{
"message": "string",
"code": 0,
"fieldErrors": {
"property1": null,
"property2": null
}
}{
"message": "string",
"code": 0
}{
"message": "string",
"code": 0
}