Create a QR group
curl --request POST \
--url https://api.awardee.com/v1/qr-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"destination": {
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"article_ids": [
"5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"
],
"category_ids": [
"9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
destination: {
chatbot: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
page: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
knowledge_base: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
url: '<string>'
},
article_ids: ['5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9'],
category_ids: ['9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c']
})
};
fetch('https://api.awardee.com/v1/qr-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/qr-groups"
payload = {
"name": "<string>",
"description": "<string>",
"destination": {
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"article_ids": ["5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"],
"category_ids": ["9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "qr_group",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "unconfigured",
"destination": {
"type": "<string>",
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"article_ids": [
"5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"
],
"category_ids": [
"9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"
]
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Endpoints
Create a QR group
Groups inherit status + destination to their child QR codes when set. Pass null to keep a field inheritable from each child instead.
POST
/
qr-groups
Create a QR group
curl --request POST \
--url https://api.awardee.com/v1/qr-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"destination": {
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"article_ids": [
"5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"
],
"category_ids": [
"9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
destination: {
chatbot: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
page: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
knowledge_base: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
url: '<string>'
},
article_ids: ['5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9'],
category_ids: ['9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c']
})
};
fetch('https://api.awardee.com/v1/qr-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/qr-groups"
payload = {
"name": "<string>",
"description": "<string>",
"destination": {
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"article_ids": ["5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"],
"category_ids": ["9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "qr_group",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "unconfigured",
"destination": {
"type": "<string>",
"chatbot": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"article_ids": [
"5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"
],
"category_ids": [
"9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"
]
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Authorizations
Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.
Headers
Opaque key that makes this POST safe to retry. Responses are cached for 24h per API key.
Maximum string length:
255Body
application/json
Minimum string length:
1Available options:
unconfigured, active, inactive, archived Show child attributes
Show child attributes
Articles this resource links as knowledge. When a visitor scans it and lands on a chatbot, the chatbot searches its own knowledge plus these articles — so item-specific content (a room's TV manual) can live here instead of on the shared chatbot. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.
Example:
["5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"]
Article categories (folders) this resource links as knowledge. A linked category includes every article inside it and its sub-categories, now and in future. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.
Example:
["9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"]
Response
QR group created
Allowed value:
"qr_group"Available options:
unconfigured, active, inactive, archived Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Articles this resource links as knowledge. When a visitor scans it and lands on a chatbot, the chatbot searches its own knowledge plus these articles — so item-specific content (a room's TV manual) can live here instead of on the shared chatbot. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.
Example:
["5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9"]
Article categories (folders) this resource links as knowledge. A linked category includes every article inside it and its sub-categories, now and in future. Replace-only on write: send the full desired set, omit to leave untouched, [] to detach all.
Example:
["9f8e7d6c-5b4a-4f3e-2d1c-0b9a8f7e6d5c"]