The Uniqode API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nThe Uniqode API uses API key to authenticate requests.
\nYour API key carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\nYou can find your API key by using the following steps.
\nLogin to the Uniqode dashboard.
\nGo to your 'API' section from the sidebar.
\nCopy the API key value.
Set a plain text header named Authorization with the contents of the header being Token XXX where XXX is your API Key.
Example header
\ncurl -X \"GET\" \"https://api.uniqode.com/api/2.0/qrcodes/\" -H \"Authorization: Token Your.API.Key-HERE\" -H \"Content-Type: application/json\"\n\nThe Custom URL campaign drives users to the specified URL once they scan the QR Code.
\ncontent_type : 1
Fields:\ncustom_url
The Custom URL campaign drives users to the specified URL once they scan the QR Code.
\ncontent_type : 13
Fields:pdf
Supported Attributes
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"880d3779-a937-41b3-9497-b0e34bd947e6"},{"name":"Markdown Card","id":"3878cc7d-baa1-4e6f-b64e-629ee4ec9341","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Markdown Card\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 2,\n \"markdown_card\": {{markdown_card_id}}\n },\n \"location_enabled\": false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The Landing Page campaign shows the user a dedicated landing page once they scan the QR Code. You need only specify the Markdown Card ID.
\ncontent_type : 2
Field:\nmarkdown_card
The Form campaign displays a form to users who scan the QR code. Upon accessing the form, they can fill in the relevant information. You need only sspecify the ID of the Form.
\ncontent_type : 3
Field:\nform
The vCard Plus campaign lets users access your contact details once they scan the QR Code. Users can save the contact to their device from the landing page.
\ncontent_type : 7
field:vcard_plus
Supported Attributes
\nSupported customizations
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"97e92510-8ec5-4582-95e1-064ab5adf30f"},{"name":"App Links","id":"232d23c2-aa9b-4742-811e-1976db304cdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Nearbee App download QR Code\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 5,\n \"app_links\": {\n \"iphone_url\": \"https://apps.apple.com/us/app/nearbee/id1342629048\",\n \"android_url\": \"https://play.google.com/store/apps/details?id=com.uniqode.nearbee&hl=en&gl=US\",\n \"fallback_url\": \"https://www.uniqode.com\"\n }\n },\n \"location_enabled\":false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The App Links campaign redirects users to either the App Store or Google Play store depending on their OS. Users can scan the QR Code and download the app relevant to their device.
\ncontent_type: 5
Field:\napp_links
Supported Attributes
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"232d23c2-aa9b-4742-811e-1976db304cdb"},{"name":"Phone call","id":"6e0c1f2d-c167-463c-91dd-6f6c8aff901d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Call by phone\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 15,\n \"phone_call\": {\n \"phone\": \"+16469680378\"\n }\n },\n \"location_enabled\":false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The Phone Call campaign allows users to make a call without having to dial the phone number manually. All they need to do is scan the QR Code.
\ncontent_type: 15
Field:\nphone_call
Supported Attributes
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e0c1f2d-c167-463c-91dd-6f6c8aff901d"},{"name":"SMS","id":"29ff1690-1bac-4a52-8e53-53c2d8c70c0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"SMS\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 16,\n \"phone_sms\": {\n \"phone\": \"+16469680378\",\n \"body\": \"Hello World\"\n }\n },\n \"location_enabled\":false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The SMS campaign lets users send predefined text messages once they scan the QR Code. Details such as the recipient’s phone number and message will be prefilled.
\ncontent_type: 16
Field:\nphone_sms
Supported Attributes
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"29ff1690-1bac-4a52-8e53-53c2d8c70c0b"},{"name":"Email","id":"a6d5a450-ebff-42f3-b9fb-3d2e3f3cc333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Email\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 17,\n \"email\": {\n \"email\": \"support@uniqode.com\",\n \"subject\": \"Queries\",\n \"body\": \"I had a few queries with your products.\"\n }\n },\n \"location_enabled\": false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The Email campaign lets users send predefined emails once they scan the QR Code. Details such as the recipient’s email address, the subject, and the body of the email will be prefilled.
\ncontent_type: 17
Field:\nemail
Supported Attributes
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6d5a450-ebff-42f3-b9fb-3d2e3f3cc333"},{"name":"Social Media","id":"5b36e54b-1f08-4bba-a3ca-7e09a3fbf243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Uniqode Social Media QR Code\",\n \"organization\": {{ORG_ID}},\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 8,\n \"social_media\": {\n \"title\": \"Uniqode\",\n \"urls\": {\n \"facebook\": \"https://www.facebook.com/uniqode\",\n \"linkedin\": \"https://www.linkedin.com/showcase/uniqode/\",\n \"twitter\": \"https://www.twitter.com/uniqode/\"\n },\n \"logo_url\": \"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"brand_image\": \"https://static.uniqode.com/assets/img/uniqode-banner.png\",\n \"message\": \"Join us on social media\",\n \"sub_text\": \"Connect with us to hear about product updates, announcements and offers\",\n \"customizations\": {\n \"title_color\": \"#2595FF\",\n \"message_background_color\": \"#dae9f7\"\n }\n }\n },\n \"location_enabled\": false,\n \"attributes\":{\n \"color\":\"#2595ff\",\n \"colorDark\":\"#2595ff\",\n \"margin\":80,\n \"isVCard\":false,\n \"frameText\":\"UNIQODE\",\n \"logoImage\":\"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50\",\n \"logoScale\":0.1992,\n \"frameColor\":\"#2595FF\",\n \"frameStyle\":\"banner-bottom\",\n \"logoMargin\":10,\n \"dataPattern\":\"square\",\n \"eyeBallShape\":\"circle\",\n \"gradientType\":\"none\",\n \"eyeFrameColor\":\"#2595FF\",\n \"eyeFrameShape\":\"rounded\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/","description":"The Social Media campaign displays all your social media channels in one place once the user scans the QR Code.
\ncontent_type : 8
field:social_media
Supported Attributes
\nSupported customizations
Supported urls
The Facebook campaign links users to a customized landing page where they can like and follow your Facebook profile or business page once they scan the QR Code.
\ncontent_type : 9
Field:\nfacebook_page
Supported Attributes in facebook_page
The Coupon campaign allows users to access coupon codes by scanning the QR Code. Users can save the coupon code to their device from the landing page (wallet pass on iOS and Gallery image on Android).
\ncontent_type : 10
Field:\ncoupon
Supported Attributes
\nSupported customizations
Supported wallet_pass formatting
The Business Card campaign lets you display your digital business card to users once they scan the QR Code.
\ncontent_type: 11
Field:\nbusiness_card
Supported Attributes
\nSupported customizations
Supported contact options
Supported open_hours options:
The keys for the objects should be days of the week. Any day, if not specified will be marked as Closed.
\nOptions for opens and closes:
Smart Rules QR Codes are condition-controlled QR Codes that can trigger different actions based on specific conditions when scanned.
\ncontent_type : 23
Fields:smart_rules
rules : array of rules
rule_operator : and/or
Supported Rules
\nIf none of the conditions match for a particular scan, then the default redirection takes place.
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"10461ed5-1b6a-4846-b99e-c1043ee8acd7"}],"id":"fc5f83ab-6c38-4738-9d25-80e0f9eab387","description":"Dynamic QR Codes allow the capability to edit your QR Codes on the fly as per your requirements. They also help track analytics based on the engagement of Users with your QR Codes.
\nThe behaviour of dynamic QR Codes are dependent on their campaign object. The following campaign types are supported:
\nSchedule
\nMulti-language Content
\nStatic QR Codes can be used to help Users perform different actions based on the type. These QR Codes cannot be edited or used to track activity.
Static QR Code types supported by Uniqode.
\nwebsitephonesmsemailvCardtextwifiList all the QR Codes templates in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","qrtemplates",""],"host":["https://api.uniqode.com/api"],"query":[{"disabled":true,"key":"name__icontains","value":null},{"disabled":true,"key":"organization","value":null}],"variable":[]}},"response":[],"_postman_id":"dc4d8909-e20e-4ba2-8bdf-6f4a18a85c7d"},{"name":"Retrieve a template","id":"a6f80c7c-f255-46b3-b661-660d60c9854a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrtemplates/23153/","description":"Retrieves the details of the specified QR Code template. You need only supply the unique QR Code identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","qrtemplates","23153",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6f80c7c-f255-46b3-b661-660d60c9854a"},{"name":"Create template","id":"ae9ddd0f-e0eb-441e-94b2-98e2944dfd46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"meta\": {},\n \"name\": \"New Template\",\n \"organization\": ,\n \"dataPattern\": \"square\",\n \"colorDark\": \"#000000\",\n \"colorLight\": \"#ffffff\",\n \"gradientType\": \"none\",\n \"eyeBallShape\": \"square\",\n \"eyeBallColor\": \"#000000\",\n \"eyeFrameShape\": \"square\",\n \"eyeFrameColor\": \"#000000\",\n \"logoScale\": 0.15,\n \"logoImage\": \"\",\n \"backgroundImage\": \"\",\n \"backgroundColor\": \"#ffffff\",\n \"frameStyle\": \"none\",\n \"frameColor\": \"#000000\",\n \"frameText\": \"SCAN ME\",\n \"frameTextColor\": \"#ffffff\",\n \"logoBackground\": true,\n \"default\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrtemplates/","description":"Creates a QR Code template using the provided parameters. Any parameters not provided will be set to the default value. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","qrtemplates",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae9ddd0f-e0eb-441e-94b2-98e2944dfd46"},{"name":"Update template","id":"76021afc-fe64-45ef-98d1-5502fc63001d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\" : \"Basic template\",\n \"organization\": ,\n \"dataPattern\": \"circle\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrtemplates/23153/","description":"Updates the QR Code template specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","qrtemplates","23153",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"76021afc-fe64-45ef-98d1-5502fc63001d"},{"name":"Delete Template","id":"62d91e62-f46f-4112-ad2b-4df88f9674f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrtemplates/","description":"Delete QR Code template based on its ID.
\n","urlObject":{"path":["2.0","qrtemplates",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"62d91e62-f46f-4112-ad2b-4df88f9674f5"}],"id":"a1c04252-31fe-4fde-af90-c3775975e556","description":"QRCodeTemplate objects allow you to perform actions on templates, which can be used to apply preset styles to your QR codes.
These requests can be used to generate QR codes in bulk by uploading a CSV/XLSX file (similar to the BULK_UPLOAD option in the Uniqode dashboard).
\n","_postman_id":"26dace3a-ac77-4313-882b-8265af804346"},{"name":"List all QR Codes in account","id":"3036ef75-c9ee-4161-8261-45eea0f27b34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/?campaign__content_type=13","description":"List all the QR Codes in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","qrcodes",""],"host":["https://api.uniqode.com/api"],"query":[{"disabled":true,"key":"qr_type","value":""},{"key":"campaign__content_type","value":"13"},{"disabled":true,"key":"name__icontains","value":""},{"disabled":true,"key":"organization","value":null}],"variable":[]}},"response":[],"_postman_id":"3036ef75-c9ee-4161-8261-45eea0f27b34"},{"name":"Retreive a QR Code","id":"63b14200-8fa7-4479-93e7-7c3a37b24e13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/67137/","description":"Retrieves the details of the sprcified QR Code. You need only supply the unique QR Code identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","qrcodes","67137",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"63b14200-8fa7-4479-93e7-7c3a37b24e13"},{"name":"Update a QR Code","id":"ceda4d86-91fa-498d-bb03-3e45033f6c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\",\n \"qr_type\": 2,\n \"campaign\": {\n \"content_type\": 1,\n \"custom_url\": \"https://www.uniqode.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/qrcodes/42039/","description":"Updates the QR Code specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","qrcodes","42039",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"ceda4d86-91fa-498d-bb03-3e45033f6c25"},{"name":"Delete QR Code","id":"c7a5b81e-5cbc-4cf5-9a25-3c18f13f9329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/53185/","description":"Delete QR Code based on its ID.
\n","urlObject":{"path":["2.0","qrcodes","53185",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7a5b81e-5cbc-4cf5-9a25-3c18f13f9329"},{"name":"Download QR Code image","id":"6b8e3572-dd9a-4f6c-880b-bdd9c140ab76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/83746/download/?size=1024&error_correction_level=2&canvas_type=pdf","description":"Download a QR code in a particular size and image format. Image types supported are PNG, JPEG, SVG and PDF. You need only pass the ID of the QR Code in the request URL.
\nReturns response with the URLs for downloading the QR Code image in the specified canvas type. If no canvas type is sent in the parameters, the QR Code would be generated in all image formats supported.
\n","urlObject":{"path":["2.0","qrcodes","83746","download",""],"host":["https://api.uniqode.com/api"],"query":[{"description":{"content":"The size of the QR Code image
\n","type":"text/plain"},"key":"size","value":"1024"},{"description":{"content":"The error correction level for the QR Code
\n","type":"text/plain"},"key":"error_correction_level","value":"2"},{"description":{"content":"Image format
\n","type":"text/plain"},"key":"canvas_type","value":"pdf"},{"disabled":true,"description":{"content":"Template for table tent-cards (supports onky pdf canvas_type)
\n","type":"text/plain"},"key":"qr_template","value":"plain_template"},{"disabled":true,"description":{"content":"Template size (1: 4/6inches, 2: 5/7 inches)
\n","type":"text/plain"},"key":"template_size","value":"1"},{"disabled":true,"description":{"content":"Logo URL for the template
\n","type":"text/plain"},"key":"logo_url","value":"https://d1bqobzsowu5wu.cloudfront.net/15406/36caec11f02d460aad0604fa26799c50"}],"variable":[]}},"response":[],"_postman_id":"6b8e3572-dd9a-4f6c-880b-bdd9c140ab76"},{"name":"Activate QR Code","id":"690d9ab3-bb43-4b3d-b92b-133bed22c43c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/83746/activate/","description":"Activates the QR Code, i.e. changes the state of the QR Code from Sleeping state (S) to Active state (A).
This API is applicable only on Dynamic QR Codes.
\n","urlObject":{"path":["2.0","qrcodes","83746","activate",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"690d9ab3-bb43-4b3d-b92b-133bed22c43c"},{"name":"Deactivate QR code","id":"3aa8c8a1-d3a2-4173-b9a2-08487d171bb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/qrcodes/83746/activate/","description":"Deactivates the QR Code, i.e. changes the state of the QR Code from Active state (A) to Sleeping state (S).
This API is applicable only on Dynamic QR Codes.
\n","urlObject":{"path":["2.0","qrcodes","83746","activate",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3aa8c8a1-d3a2-4173-b9a2-08487d171bb0"}],"id":"0854795d-b681-4196-ba6a-f5f54f1fcbfd","description":"QRCode objects allow you to perform actions on your QR Codes. You can create a QR Code, retrieve or update individual QR Codes as well as a list of all your QR Codes.
QRCode object:
attributes object (design of the QR Code):
campaign object (Campaign associated with the QR Code):
Refer Create Dynamic QR Code for more details about individual campaign types
\n","event":[{"listen":"prerequest","script":{"id":"7188dffb-092d-44cb-a7f2-cddacc28eb83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c95e84c3-3771-4b5d-aaa4-df70c110562f","type":"text/javascript","exec":[""]}}],"_postman_id":"0854795d-b681-4196-ba6a-f5f54f1fcbfd"},{"name":"Digital Business Card","item":[{"name":"Card Templates","item":[{"name":"List Card Templates","id":"00555e85-a912-4080-ac49-b654a4b5566a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/dbc/templates/?organization={{ORG_ID}}&page_size=50&page=1","description":"Fetch and list all the Cards' templates in your account. You can filter and paginate your results using query params.
\nRefer QR Code template section to know more about the use of query params for filtering.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","dbc","templates",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"},{"key":"page_size","value":"50"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"00555e85-a912-4080-ac49-b654a4b5566a"}],"id":"e263a355-493a-4bac-a766-bf51137c85a8","description":"Any DigitalBusinessCard which has is_template field as True is considered as a Card template. These templates can be used to apply preset styles to your Cards.
Download a QR Code for the Card in a particular size and image format. You need to pass the ID of the respective card in the request params.
\nYou can pass image format (canvas_type), size (size) and organization id (organization) as query params.
Returns response with the URLs for downloading the QR Code image in the specified canvas type. If no canvas type is sent in the parameters, the QR Code would be generated in all image formats supported.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}","download",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"canvas_type","value":"png"},{"key":"size","value":"1024"},{"key":"error_correction_level","value":"2"},{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"8cf6cd94-952f-492e-8d41-811401584195"},{"name":"Bulk Download Card QR Code Images","id":"b721e35a-9737-400d-ac25-8e2a1cc901d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Bulk download\",\n \"size\": 1024,\n \"ids\": [\n {{CARD_ID}}\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/dbc/qrcode/list/?organization={{ORG_ID}}","description":"Downloads QR codes for the Card's in bulk in a particular size, image format and error correction level passed in request body.
\nNote: It's mandatory to pass the IDs of the Cards in request body.
Returns response with the URL for downloading all QR Code images in a zip file in the specified canvas type. If no canvas type is sent in the parameters, the QR Codes would be generated in all image formats supported and the zip file will be sent to your registered email id.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","qrcode","list",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"b721e35a-9737-400d-ac25-8e2a1cc901d8"},{"name":"Bulk Download Filtered Card QR Code Images","id":"8744c7ba-64f9-46e3-b3e8-4d3e4b53f7aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Bulk download\",\n \"size\": 1024,\n \"filters\": {\n \"organization\": {{ORG_ID}},\n \"card_owner\": {{USER_ID}},\n \"state\": \"A\",\n \"card_owner__email__icontains\": \"john\"\n },\n \"canvas_type\": \"png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/dbc/qrcode/filter/?organization={{ORG_ID}}","description":"Downloads QR codes in bulk for the filtered Cards using filters provided in the request body. The filtered Cards are downloaded in a particular size, image format and error correction level supplied in the request body.
\nYou can add filters according to your need in the filters object in request body. The supported filters for filtering operation are card_owner__email__icontains (Owner Email), url__iconatins (Card Link), first_name__icontains (First Name), last_name__icontains (Last Name), state (Card State) and organization (Card's Organization).
Returns response with the URL for downloading all QR Code images in a zip file in the specified canvas type. If no canvas type is sent in the parameters, the QRCodes would be generated in all image formats supported and the zip file will be sent to your registered email id.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","qrcode","filter",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"8744c7ba-64f9-46e3-b3e8-4d3e4b53f7aa"}],"id":"dee59ae0-61ed-4ff0-824f-3bf6928cceca","description":"This folder contains APIs related to Card's QR Code operations. For every Card a unique url is generated and this unique url is then used to create QR Code for this Card. Supported image types for Card's QR Code operations are png, jpeg, svg ,pdf and eps. Supported image sizes for Card's QR Code operations are 512, 1024, 2048 and 4096.
Retrieves all wallet passes of the Card. You need to provide the unique Card identifier in the request params and the unique Organization identifier in query params.
\nNote: Passing Organization ID in query params is mandatory.
Returns response with the detail of success or failure of the action.
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}","walletpass",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"2d3af535-0fa8-43da-a1e4-36121f7910e1"},{"name":"Create Wallet Pass for a Card","id":"3d33ae3c-4db0-4aad-a7e2-e0eb477a5344","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"emails\": [\n \"john@uniqode.com\"\n ],\n \"background\": \"2f1616\",\n \"foreground\": \"edbd55\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/dbc/{{CARD_ID}}/walletpass/?organization={{ORG_ID}}","description":"Creates new Wallet Pass for the card. You need to provide the unique card identifier in the request params and the unique organization identifier in query params. The email addresses provided in the request body will receive an email with the Wallet Pass.
\nNote: Passing organization ID in query params and emails list in request body is mandatory.
You can pass the hex code for the background color and text color of Wallet Pass against background field and foreground field respectively in request body.
Google Wallet Pass does not support font/foreground color.
\nIncase Wallet pass template is restricted, The current foreground or background value won't be overeridden.
Returns response with the detail of success or failure of the action.
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}","walletpass",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"3d33ae3c-4db0-4aad-a7e2-e0eb477a5344"}],"id":"66f68e38-ed86-43b7-a288-a52518f90277","description":"This folder contains APIs related to retrieval and creation of apple wallet pass and google wallet pass for a Card.
\n","_postman_id":"66f68e38-ed86-43b7-a288-a52518f90277"},{"name":"Bulk Operations for Cards","item":[{"name":"CSV Validation For Bulk Card Generation","id":"6ac7fdc7-b40c-413a-b6a3-a6217723ca2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"The CSV file to be validated.
\n","type":"file","value":null},{"key":"organization","value":"{{ORG_ID}}","description":"The ID of the organization in which we want to create the cards.
\n","type":"text"}]},"url":"https://api.uniqode.com/api/2.0/dbc/csv-validation/","description":"Validates the csv/xlsx file which is to be used for bulk creation of cards. You need to provide the file content and the unique Organization identifier in request body.
\nNote : It is mandatory to pass unique organization identifier in request body.
The major validations performed on the input file are as follows:
\ncsv and xlsxfirst name, card owner email and role.The response consists of the following fields in case the API call is successful.
\nThe response consists of the below field in case of API failure.
\n","urlObject":{"path":["2.0","dbc","csv-validation",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ac7fdc7-b40c-413a-b6a3-a6217723ca2c"},{"name":"Bulk Card Generation","id":"a589ec5c-6e08-40c1-abff-34b79242a0c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"organization","value":"{{ORG_ID}}","description":"The ID of the organization to which the card belongs.
\n","type":"text"},{"key":"background_color","value":"#EE4F4F","description":"The background color of the card.
\n","type":"text"},{"key":"user_info_color","value":"#FFFFFF","description":"The color used for showing user info in the card.
\n","type":"text"},{"key":"secondary_color","value":"#000000","description":"The color used for other secondary elements.
\n","type":"text"},{"key":"font_style","value":"Open Sans","description":"The font style for the card. We support all the Google fonts.
\n","type":"text"},{"key":"layout","value":"3","description":"The layout selected for the card.
\n","type":"text"},{"key":"autodownload_v2","value":"false","description":"The boolean flag indicating whether we want the card to be downloaded or not.
\n","type":"text"},{"key":"location_enabled","value":"false","description":"The boolean flag indicating whether we want to track the GPS location of the user or not.
\n","type":"text"},{"key":"auto_send_wallet_pass","value":"false","description":"The boolean flag indicating whether we want the card to be downloaded or not.
\n","type":"text"},{"key":"company_logo","value":"","description":"The company logo URL.
\n","type":"text"},{"key":"template","value":"{}","description":"The card template data.
\n","type":"text"},{"key":"lead_collection","value":"false","description":"The boolean flag indicating whether we want the contact's info to be collected or not.
\n","type":"text"},{"key":"lead_phone","value":"false","description":"The boolean flag indicating whether we want the contact's phone number to be collected or not.
\n","type":"text"},{"key":"lead_designation","value":"false","description":"The boolean flag indicating whether we want the contact's designation to be collected or not.
\n","type":"text"},{"key":"lead_notes","value":"false","description":"The boolean flag indicating whether we want the contact's notes to be collected or not.
\n","type":"text"},{"key":"file","description":"The CSV file to create the cards.
\n","type":"file"},{"key":"typography","value":"{\"bio\":{\"google_font_style\":\"Light\"},\"button\":{\"google_font_style\":\"Light\"},\"font_type\":\"google\",\"font_family\":\"Open Sans\",\"personal_info\":{\"google_font_size\":24,\"google_font_style\":\"Light\"},\"company_details\":{\"google_font_style\":\"Light\"},\"contact_details\":{\"google_font_style\":\"Light\"}}","description":"The typography json field to set the typography of the card.
\n","type":"text"}]},"url":"https://api.uniqode.com/api/2.0/dbc/bulkcreate/","description":"Creates cards in bulk according to the input file provided in the request. When the request is fully processed and your cards are created and ready for use, card's owner will receive an email regarding the same. You need to provide the file content and the unique organization identifier in request body along with other cards configurations.
\nNote : It is mandatory to pass unique organization identifier in request body.
You need to first run CSV Validation for bulk Card Generation API before this API to validate the csv file. If there are no errors found, then you can hit this API.
\nThe response consists of the following fields.
\n","urlObject":{"path":["2.0","dbc","bulkcreate",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a589ec5c-6e08-40c1-abff-34b79242a0c8"},{"name":"Bulk Delete Cards","id":"40fd1fc0-46b5-44c7-85f5-87f877e90e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n {{CARD_ID}}\n ],\n \"organization\": {{ORG_ID}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/dbc/bulkdelete/list/?organization={{ORG_ID}}","description":"Delete Cards in bulk based on Card IDs (Unique Indentifier for Card).
\nReturns response containing detail of success / failure.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","bulkdelete","list",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"40fd1fc0-46b5-44c7-85f5-87f877e90e3c"}],"id":"73b7303c-028d-4c33-ac6f-21bc7bd7f988","description":"These requests can be used to generate cards in bulk by uploading a CSV/XLSX file.
\nWe recommend using our data templates for accurate results.
\n\n\n","_postman_id":"73b7303c-028d-4c33-ac6f-21bc7bd7f988"},{"name":"Lead","item":[{"name":"List Leads","id":"5bcaaa0b-93d0-4a84-b717-e68731940bbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/lead/","description":"List all the Lead objects in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","lead",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bcaaa0b-93d0-4a84-b717-e68731940bbe"},{"name":"Delete Lead","id":"b7257f60-74da-4640-a157-ad428364da0e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/lead/{{LEAD_ID}}/","description":"Deletes the Lead specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","lead","{{LEAD_ID}}",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7257f60-74da-4640-a157-ad428364da0e"},{"name":"Export leads","id":"1d1d66fe-f2a2-4fcf-80b8-8cf6268c7383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.uniqode.com/api/2.0/lead/export/","description":"The Leads Report API is designed to provide organizations with a convenient way to retrieve a comprehensive CSV report of all the leads captured for their organization. This API is especially useful for sales, marketing, and management teams who need to analyze and manage lead data efficiently.
\n","urlObject":{"path":["2.0","lead","export",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d1d66fe-f2a2-4fcf-80b8-8cf6268c7383"}],"id":"237925fd-f3d9-4ba1-a6bc-891002c7ce0a","description":"The Lead Management API provides an interface for managing leads within an organization. It offers endpoints to list, retrieve, and delete lead records, as well as to export lead data.
\nLead object:
List all the Cards in your account. You can filter and paginate your results using query params.
\nRefer QR Code section to know more about the use of query params for filtering.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","dbc",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"},{"key":"page_size","value":"10"},{"key":"page","value":"1"},{"key":"state","value":"A"},{"key":"card_owner__is","value":"{{USER_ID}}"}],"variable":[]}},"response":[],"_postman_id":"951740de-57fc-46dd-87e7-7ea338d8f4e1"},{"name":"Retreive a Card","id":"6c084d13-d6e1-43d0-bf2c-baf6c6992677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/dbc/{{CARD_ID}}/?organization={{ORG_ID}}","description":"Retrieves the details of the specified Card. You only need to provide the unique Card identifier that was returned upon listing. The response contains the DigitalBusinessCard object as requested.
Creates a digital business card. This API creates a DigitalBusinessCard object and returns response consisting of the created Card object.
Note: It is mandatory to pass first_name, organization and customizations in request body.
The customizations object must have the following fields:
background_coloruser_info_colorsecondary_colortypographytypography object for google font should look like:
{\n \"font_type\": \"google\",\n \"font_family\": \"Open Sans\",\n \"personal_info\": {\n \"google_font_size\": 24,\n \"google_font_style\": \"Semi Bold\"\n },\n \"company_details\": {\n \"google_font_style\": \"Regular\"\n },\n \"contact_details\": {\n \"google_font_style\": \"Semi Bold\"\n },\n \"bio\": {\n \"google_font_style\": \"Regular\"\n },\n \"button\": {\n \"google_font_style\": \"Regular\"\n }\n}\n\nwhere google_font_style can have values Light, Regular, Medium, Semi Bold, Bold which constitute to font_weight values 300, 400, 500, 600, 700 respectively.
typography object for custom font should look like:
{\n \"font_type\": \"custom\",\n \"font_family\": \"CUSTOM_FONT_NAME\",\n \"personal_info\": {\n \"custom_font_size\": 24,\n \"custom_font_style\": \"CUSTOM_FONT_STYLE\",\n \"custom_font_url\": \"CUSTOM_FONT_S3_URL\"\n },\n \"company_details\": {\n \"custom_font_style\": \"CUSTOM_FONT_STYLE\",\n \"custom_font_url\": \"CUSTOM_FONT_S3_URL\"\n },\n \"contact_details\": {\n \"custom_font_style\": \"CUSTOM_FONT_STYLE\",\n \"custom_font_url\": \"CUSTOM_FONT_S3_URL\"\n },\n \"bio\": {\n \"custom_font_style\": \"CUSTOM_FONT_STYLE\",\n \"custom_font_url\": \"CUSTOM_FONT_S3_URL\"\n },\n \"button\": {\n \"custom_font_style\": \"CUSTOM_FONT_STYLE\",\n \"custom_font_url\": \"CUSTOM_FONT_S3_URL\"\n }\n}\n\nwhere custom_font_url should be the S3 urls of the custom fonts that were uploaded on the dashboard.
Also, make sure thevalue of phone_v2, email_v2 and website_v2 are correct in accordance with the values in regex. The label value in phone_v2, email_v2and website_v2 should be either from default labels, custom labels (defined for the organization) or labels defined in card template (if card_template is provided).
card_template field in request body can used to create the business card using existing organization templates. This is an optional field and can be omitted. If card_template is passed then restricted field values are picked from the provided card template.
Updates the Card specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\nReturns response containing the updated Card object.
\nNote: It is mandatory to pass first_name, organization and customizations in request body.
Refer to Create Card API to know about the validations on the request data.
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"5f14f0b8-59a4-40ca-ba49-6f9aff849b21"},{"name":"Delete Card","id":"51630b90-8114-46ec-82b2-8dcfa7df6a6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/dbc/{{CARD_ID}}/?organization={{ORG_ID}}","description":"Delete DigitalBusinessCard based on its unique indentifier.
\nReturns response containing detail of success / failure. The detail key contains value of type string which is a success or failure message accordingly.
The response consists of:
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"51630b90-8114-46ec-82b2-8dcfa7df6a6b"},{"name":"Activate Card","id":"6ff7e3d8-d9b1-4dea-a1ae-344b25c10521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/dbc/{{CARD_ID}}/activate/?organization={{ORG_ID}}","description":"Activates the Card, i.e. changes the state of the Card from Sleeping state (S) to Active state (A).
This API will return 400 response in case the Card is already in Active state.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}","activate",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"6ff7e3d8-d9b1-4dea-a1ae-344b25c10521"},{"name":"Deactivate Card","id":"79b325a3-81f8-4cf1-ac60-dafd554d2786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/dbc/{{CARD_ID}}/activate/?organization={{ORG_ID}}","description":"Deactivates the Card, i.e. changes the state of the Card from Active state (A) to Sleeping state (S).
This API will return 400 response if the Card is already in Sleeping state.
\nThe response consists of:
\n","urlObject":{"path":["2.0","dbc","{{CARD_ID}}","activate",""],"host":["https://api.uniqode.com/api"],"query":[{"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"79b325a3-81f8-4cf1-ac60-dafd554d2786"}],"id":"d631da62-b420-41d9-b0f6-d094455991ef","description":"DigitalBusinessCard objects allow you to perform actions on your Digital Business Cards. You can create a card, retrieve or update cards separately or in bulk.
DigitalBusinessCard object:
LeadAttribute object (LeadAttribute associated with the DigitalBusinessCard):
CustomDomain object (CustomDomain associated with the DigitalBusinessCard):
Refer User section and Organization section for more details about the User and Organization models associated with DigitalBusinessCard.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5aaaa1cb-027b-4c2f-9bdd-ca69c156c638"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d17bad23-67ec-44a4-9937-d807bcdf51a4"}}],"_postman_id":"d631da62-b420-41d9-b0f6-d094455991ef"},{"name":"Tag","item":[{"name":"List tags","id":"f177a6d9-cd89-41de-99e5-b5f27af84aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/tags/?name__icontains=","description":"List tags
\n","urlObject":{"path":["2.0","tags",""],"host":["https://api.uniqode.com/api"],"query":[{"disabled":true,"key":"organization","value":"1189"},{"key":"name__icontains","value":""}],"variable":[]}},"response":[],"_postman_id":"f177a6d9-cd89-41de-99e5-b5f27af84aa8"},{"name":"Get tag","id":"293a36fb-5631-4067-ab67-f654b988b573","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/tags/859/","description":"Get a single tag
\n","urlObject":{"path":["2.0","tags","859",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"293a36fb-5631-4067-ab67-f654b988b573"},{"name":"Update tag","id":"297c5e60-47c4-4611-880f-681b5fbf8e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Token {{TOKEN}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 859,\n \"name\": \"hi\",\n \"slug\": \"hi\",\n \"organization\": 1284,\n \"beacon_set\": [ 1189\n ]\n }"},"url":"https://api.uniqode.com/api/2.0/tags/859/","description":"Update a tag
\n","urlObject":{"path":["2.0","tags","859",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"297c5e60-47c4-4611-880f-681b5fbf8e4e"},{"name":"Create tag","id":"56f578da-ce02-4f18-b539-4cdeec43bb40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token 08ddda7aabcbecfa54b29f6d032d7d289eb241b5"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Shashank Beacons label 1\",\n \"color\": \"#0079bf\",\n \"organization\": 1697,\n \"qrcode_set\": [],\n \"beacon_set\": [],\n \"nfctag_set\": [],\n \"geofence_set\": []\n}"},"url":"https://api.uniqode.com/api/2.0/tags/","description":"Create a new tag
\n","urlObject":{"path":["2.0","tags",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"56f578da-ce02-4f18-b539-4cdeec43bb40"},{"name":"Delete tag","id":"bb63d2ff-5378-4a7e-81ea-c2a79ab87475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Token {{TOKEN}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.uniqode.com/api/2.0/tags/1047/","description":"Delete a tag
\n","urlObject":{"path":["2.0","tags","1047",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb63d2ff-5378-4a7e-81ea-c2a79ab87475"}],"id":"7a6eca49-9021-426b-b07d-49a33bbb120a","description":"Tag objects allow you to perform actions on tags, which can be used to add a label to your QRCode objects, and filter the QR codes, and their analytics using these labels.
Returns the performance of the product in terms of number of scans/impressions served for the given duration at the specified intervals.
\nRequest data fields:
\nResponse data:
\nReturns data with the column values in the format:
\n[\n \"product_id\",\n \"product_name\",\n \"product_identifier\",\n \"total_notification_count\",\n \"total_impression_count\",\n \"total_ctr\",\n \"place_id\",\n \"place_name\",\n [\n [\n \"epoch_date\",\n \"notification_count\",\n \"impression_count\",\n \"ctr\"\n ]\n ]\n]\nSends an email to the specified address with a CSV file consisting of every metric of analytics for the specified duration associated with the given Product/Products.
\nNote: If the size of the CSV file generated exceeds 5MB, the email sent will contain a link to download password protected zip file.
\nRequest data fields:
\nReturns combined data for all Products in the account if empty _product_id_ (_[]_) is passed.
If email is not passed, the mail is automatically sent to the email of the user making the request.
Response data:
\nReturns the response as shown below when email is sent successfully.
\n{\n \"columns\": 1,\n \"points\": 1\n}\n\nReturns the operating systems of devices that were used to scan/view the Product.
\nRequest data fields:
\nReturns combined data for all Products in the account if empty product_id ([]) is passed.
Response data:
\nReturns the operating system under columns, and number of devices belonging to that operating system which were used to scan/view the Product under points.
Operating systems considered
\nAndroid, iOS, iPadOS, Mac, Windows
Devices that do not use either of the above mentioned Operating Systems will be classified as other
Returns the cities from where the Product was scanned/viewed.
\nRequest data fields:
\nReturns combined data for all Products in the account if empty product_id ([]) is passed.
Response data:
\nReturns the City under columns, and number of viewers who scanned/viewed the Product from that city under points.
Returns the GPS location information of the users from where the Product was scanned. You need to enable the location_enabled field on the Product object (Beacon, QRCode, NFCTag, Geofence) for enabling the Product to collect the data.
This data can only be retreived if the user allows permission from his/her device when prompted by the browser upon scanning/viewing the Product. If the user denies permisssion, an approximate location can sstill be determined based on the User's IP address.
\nRequest data fields:
\nReturns combined data for all Products in the account if empty product_id ([]) is passed.
Response data:
\nReturns a list of lists with the following information.
\njson\n[\n \"time\",\n \"ipAddress\",\n \"userAgent\",\n \"beacon\",\n \"beaconURL\",\n \"beaconName\",\n \"fingerprint\",\n [\n \"city\",\n \"postal\",\n \"country_name\",\n \"latitude\",\n \"longitude\"\n ],\n [\n \"street_number\",\n \"sublocality_level_3\",\n \"sublocality_level_2\",\n \"sublocality_level_1\",\n \"locality\",\n \"administrative_area_level_2\",\n \"administrative_area_level_1\",\n \"postal_code\",\n \"country\",\n \"latitude\",\n \"longitude\"\n ]\n]\nGeneral description:
\nIP based location information:
\nGPS based location information:
\n","urlObject":{"path":["2.0",""],"host":["https://api.uniqode.com/reporting"],"query":[{"key":"organization","value":"{{ORG_ID}}"},{"key":"method","value":"Products.getLocationDetail"}],"variable":[]}},"response":[],"_postman_id":"0d5918d7-53be-4945-8ca7-2fd8f1b8d05d"},{"name":"Get Visitor distribution","id":"dabc8532-fbb5-44cf-9df6-a7adc1c73581","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n\t\"product_id\": 53182,\n\t\"from\": \"1579158356477\",\n\t\"to\": \"1883317799999\",\n\t\"product_type\": \"qr\",\n \"interval\": \"1w\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/reporting/2.0/?organization={{ORG_ID}}&method=Products.getVisitorDistribution","description":"Returns the visitor distribution of the Product in terms of number of scans/views served and number of unique viewers for the given duration at the specified intervals.
\nReturns combined data for all Products in the account if empty product_id ([]) is passed.
Response data
\nReturns a list of values for columns based on the interval:
\n[\n \"epoch_date\",\n \"total_visitors\",\n \"unique_visitors\"\n]\nReturns the visitor distribution of the Product in terms of number of scans served and number of unique viewers for the given duration at the specified intervals.
\nRequest data fields:
\nReturns combined data for all Products in the account if empty product_id ([]) is passed.
Response data
\nReturns the days of the week under columns starting from Monday.
points contains a list of JSON objects with hour of the day and number of times the Product was viewed during that hour of the day.
Analytics APIs allow you to analyse and assess the performance of your Products in Uniqode.
\nOrganization ID needs to be passed as organization in query params.
The duration of analytics data should be passed in epoch millis as from and to in request body for all requests.
product_type is also a mandatory field and should be passed in the request body based on the type of the product you are requesting the analytics for.
Product - Product Type map
\n{\n \"points\": [\n ...\n ],\n \"columns\": [\n ...\n ]\n}\n\nList all the Markdown objects in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","markdowncards",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c839322a-f35b-438d-b8c3-d2ac2a83a805"},{"name":"Create Landing Page","id":"d6eb0fc1-4a26-4771-ac53-ed04dd35e626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"organization\": {{ORG_ID}},\n \"title\": \"\",\n \"markdown_body\": \"\",\n \"html_body\": \"\",\n \"css_body\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/markdowncards/","description":"Creates a Landing Page based on the parameters passed in the request body.
\n","urlObject":{"path":["2.0","markdowncards",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6eb0fc1-4a26-4771-ac53-ed04dd35e626"},{"name":"Retreive a Landing Page","id":"6d368107-858f-456b-a08f-790bdadda160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/markdowncards/41819/","description":"Retrieves the details of the specified landing page. You need only supply the unique landing page identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","markdowncards","41819",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"6d368107-858f-456b-a08f-790bdadda160"},{"name":"Update a Landing Page","id":"8c54c97a-6e22-41b1-b253-c444172d5cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"organization\": {{ORG_ID}},\n \"title\": \"Updated Title\",\n \"markdown_body\": \"\",\n \"html_body\": \"\",\n \"css_body\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/markdowncards/{{markdown_card_id}}/","description":"Updates the Landing Page specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","markdowncards","{{markdown_card_id}}",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c54c97a-6e22-41b1-b253-c444172d5cf8"}],"id":"bba22a24-340e-44bb-866c-96ae830325b6","description":"Create mobile-friendly landing pages for users to view/interact with your content.
\nLanding Page (Markdown Card) attributes:
List all the Feedback Forms in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","forms",""],"host":["https://api.uniqode.com/api"],"query":[{"disabled":true,"description":{"content":"Filter based on part of the Form title
\n","type":"text/plain"},"key":"title__icontains","value":"Test"}],"variable":[]}},"response":[],"_postman_id":"a77318b2-21a1-4731-8ac6-d750d042cb43"},{"name":"Create Form","id":"835b58c2-9738-4809-a856-fc162a6b1f2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"form_structure\": {\n \"type\": \"form\",\n \"logic\": [\n {\n \"ref\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"6d60fc0e-6645-4966-84d8-10b90e37960e\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"6c24ccce-a159-4cf6-866c-9cd4d3bb4650\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"cca8c5c0-7536-4e95-bd88-4444066c2a39\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"1539a61e-73d8-48cb-a04d-3a61b082d689\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"80afef6d-fb4e-4dda-a973-99e9353dbb9a\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"e4af5729-08f4-433b-9e5c-c7fbf64cba7a\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"b7cb8a79-e557-4a3c-990c-9ac835c8c7c7\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"a0d57cef-6603-45b1-9cac-eb7e6387c76a\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"00a0cdbb-12a2-4ce1-9e0d-806996936828\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"thankyou\",\n \"value\": \"f4b1a41d-c28a-4b8c-941b-a681f4c25e2b\"\n }\n },\n \"condition\": {\n \"op\": \"greater_equal_than\",\n \"vars\": [\n {\n \"type\": \"variable\",\n \"value\": \"score\"\n },\n {\n \"type\": \"constant\",\n \"value\": 1\n }\n ]\n }\n },\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"thankyou\",\n \"value\": \"8778f1ad-dfed-4e46-8c82-7c537acfcb63\"\n }\n },\n \"condition\": {\n \"op\": \"always\",\n \"vars\": []\n }\n }\n ]\n }\n ],\n \"theme\": {\n \"href\": \"https://api.typeform.com/themes/ZyKW7J\"\n },\n \"title\": \"Test Form\",\n \"_links\": {\n \"display\": \"https://eddypro.typeform.com/to/EN78iMBv\"\n },\n \"fields\": [\n {\n \"ref\": \"cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd\",\n \"type\": \"statement\",\n \"title\": \"This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \\n\\nKeep us informed so that we can help you stay safe in these challenging times\",\n \"properties\": {\n \"hide_marks\": false,\n \"button_text\": \"Continue\"\n }\n },\n {\n \"ref\": \"bb5aa51c-e8d4-4f47-8371-3856c6dea423\",\n \"type\": \"email\",\n \"title\": \"What's your email id?\",\n \"properties\": {\n \"description\": \"This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a\",\n \"type\": \"phone_number\",\n \"title\": \"What's your mobile number?\",\n \"properties\": {\n \"description\": \"This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises\",\n \"default_country_code\": \"US\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"094fd986-95bf-4ff5-9a42-4ad25145fe11\",\n \"type\": \"short_text\",\n \"title\": \"Which doctor are you here to consult today?\",\n \"properties\": {\n \"description\": \"(Doctor name)\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you travelled to an international or domestic location in the past 3 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/fkaRQkYF6sdw\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"6d60fc0e-6645-4966-84d8-10b90e37960e\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"0e002a1c-25aa-4eae-9563-66e2fe40665a\",\n \"label\": \"No\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"b99521ba-9e6f-4357-8ed5-acf6740833d7\",\n \"type\": \"multiple_choice\",\n \"title\": \"What's your gender?\",\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"fe283bb3-7f06-43d1-83e8-dd48e663e904\",\n \"label\": \"Male\"\n },\n {\n \"ref\": \"bc0f3b2e-786d-41c4-b1e1-771878288ea5\",\n \"label\": \"Female\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": false\n }\n },\n {\n \"ref\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you experienced any of these symptoms in the last 2 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/Wy9iM7YpWDKf\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"6c24ccce-a159-4cf6-866c-9cd4d3bb4650\",\n \"label\": \"Cold and cough\"\n },\n {\n \"ref\": \"c7955809-de34-43df-b116-102e16c85a86\",\n \"label\": \"Running nose\"\n },\n {\n \"ref\": \"cca8c5c0-7536-4e95-bd88-4444066c2a39\",\n \"label\": \"Shortness of breath\"\n },\n {\n \"ref\": \"1539a61e-73d8-48cb-a04d-3a61b082d689\",\n \"label\": \"Sore throat\"\n },\n {\n \"ref\": \"80afef6d-fb4e-4dda-a973-99e9353dbb9a\",\n \"label\": \"Fever\"\n },\n {\n \"ref\": \"e4af5729-08f4-433b-9e5c-c7fbf64cba7a\",\n \"label\": \"Unsure\"\n },\n {\n \"ref\": \"e1b0c83f-704a-4526-be14-0b31572b84c1\",\n \"label\": \"None of the above\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\",\n \"type\": \"multiple_choice\",\n \"title\": \"Do any of your family members have the above symptoms?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/bYducJ2kQEzi\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"b7cb8a79-e557-4a3c-990c-9ac835c8c7c7\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"90e2efeb-a40d-4540-a1b7-b5c0bfd177d1\",\n \"label\": \"No\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you been in contact with someone with flu in the past 2 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/QkbPABHjUrqQ\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"a0d57cef-6603-45b1-9cac-eb7e6387c76a\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"88a8788c-adcf-47ad-af25-890ae332da53\",\n \"label\": \"No\"\n },\n {\n \"ref\": \"0b3f78b9-569e-4bb1-9fb9-c62ca505f466\",\n \"label\": \"Not sure\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"00a0cdbb-12a2-4ce1-9e0d-806996936828\",\n \"type\": \"statement\",\n \"title\": \"I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information\",\n \"properties\": {\n \"hide_marks\": false,\n \"button_text\": \"Continue\"\n }\n }\n ],\n \"settings\": {\n \"meta\": {\n \"allow_indexing\": false\n },\n \"is_trial\": false,\n \"language\": \"en\",\n \"is_public\": true,\n \"progress_bar\": \"percentage\",\n \"notifications\": {\n \"self\": {\n \"enabled\": true,\n \"message\": \"Your typeform {{form:title}} has a new response:\\n{{form:all_answers}}\\n\\nTeam Beaconstac\\n\",\n \"subject\": \"Typeform: New response for {{form:title}}\",\n \"recipients\": [\n \"hari.a+5678@mobstac.com\"\n ]\n },\n \"respondent\": {\n \"enabled\": true,\n \"message\": \"Hello,\\nWe’ve received your submission.\\n{{form:all_answers}}\\nThank you & have a nice day!\",\n \"subject\": \"Typeform: Thank you for filling out {{form:title}}\",\n \"recipient\": \"{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}\"\n }\n },\n \"show_progress_bar\": true,\n \"are_uploads_public\": false,\n \"show_typeform_branding\": false\n },\n \"variables\": {\n \"score\": 0\n },\n \"workspace\": {\n \"href\": \"https://api.typeform.com/workspaces/11932656\"\n },\n \"welcome_screens\": [\n {\n \"ref\": \"c4474bbc-156f-4e1d-b585-057bd0461eaf\",\n \"title\": \"We are dedicated to prevent the spread of the novel coronavirus.\\n\\nFill in the form to get access & enjoy a risk-free time inside!\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/ctp4n62CsDMm\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_text\": \"GET STARTED\",\n \"show_button\": true\n }\n }\n ],\n \"thankyou_screens\": [\n {\n \"ref\": \"8778f1ad-dfed-4e46-8c82-7c537acfcb63\",\n \"title\": \"Present this screen at the entrance to get access\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/btDfqrgjA7wN\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_mode\": \"reload\",\n \"button_text\": \"again\",\n \"share_icons\": false,\n \"show_button\": true\n }\n },\n {\n \"ref\": \"f4b1a41d-c28a-4b8c-941b-a681f4c25e2b\",\n \"title\": \"Based on your answers, we have a few additional queries, please speak with our representative\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/yvbArZPNmXj5\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_mode\": \"reload\",\n \"button_text\": \"again\",\n \"share_icons\": false,\n \"show_button\": true\n }\n },\n {\n \"ref\": \"default_tys\",\n \"title\": \"Done! Your information was sent perfectly.\",\n \"properties\": {\n \"share_icons\": false,\n \"show_button\": false\n }\n }\n ]\n },\n \"default\": false,\n \"title\": \"Test Form\",\n \"url\": \"https://eddypro.typeform.com/to/EN78iMBv\",\n \"form_id\": \"EN78iMBv\",\n \"form_type\": \"TY\",\n \"sms_structure\": {},\n \"email_structure\": {},\n \"meta\": {},\n \"created\": \"2020-08-10T13:02:37.625442+05:30\",\n \"updated\": \"2020-08-10T13:02:37.625457+05:30\",\n \"organization\": 15406,\n \"beacons\": [],\n \"form_response_count\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/forms/","urlObject":{"path":["2.0","forms",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"835b58c2-9738-4809-a856-fc162a6b1f2a"},{"name":"Retreive a Form","id":"b4ed6efb-0077-4c42-a0f6-b42a5a5de1a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/forms/49958/","description":"Retrieves the details of the specified Form. You need only supply the unique Form identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","forms","49958",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4ed6efb-0077-4c42-a0f6-b42a5a5de1a0"},{"name":"Update a Form","id":"5b18abde-012c-42fb-9edf-05dc23014329","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"form_structure\": {\n \"type\": \"form\",\n \"logic\": [\n {\n \"ref\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"6d60fc0e-6645-4966-84d8-10b90e37960e\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"6c24ccce-a159-4cf6-866c-9cd4d3bb4650\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"cca8c5c0-7536-4e95-bd88-4444066c2a39\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"1539a61e-73d8-48cb-a04d-3a61b082d689\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"80afef6d-fb4e-4dda-a973-99e9353dbb9a\"\n }\n ]\n }\n },\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"e4af5729-08f4-433b-9e5c-c7fbf64cba7a\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"b7cb8a79-e557-4a3c-990c-9ac835c8c7c7\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"add\",\n \"details\": {\n \"value\": {\n \"type\": \"constant\",\n \"value\": 1\n },\n \"target\": {\n \"type\": \"variable\",\n \"value\": \"score\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"field\",\n \"value\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\"\n },\n {\n \"type\": \"choice\",\n \"value\": \"a0d57cef-6603-45b1-9cac-eb7e6387c76a\"\n }\n ]\n }\n }\n ]\n },\n {\n \"ref\": \"00a0cdbb-12a2-4ce1-9e0d-806996936828\",\n \"type\": \"field\",\n \"actions\": [\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"thankyou\",\n \"value\": \"f4b1a41d-c28a-4b8c-941b-a681f4c25e2b\"\n }\n },\n \"condition\": {\n \"op\": \"greater_equal_than\",\n \"vars\": [\n {\n \"type\": \"variable\",\n \"value\": \"score\"\n },\n {\n \"type\": \"constant\",\n \"value\": 1\n }\n ]\n }\n },\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"thankyou\",\n \"value\": \"8778f1ad-dfed-4e46-8c82-7c537acfcb63\"\n }\n },\n \"condition\": {\n \"op\": \"always\",\n \"vars\": []\n }\n }\n ]\n }\n ],\n \"theme\": {\n \"href\": \"https://api.typeform.com/themes/ZyKW7J\"\n },\n \"title\": \"new Title\",\n \"_links\": {\n \"display\": \"https://eddypro.typeform.com/to/EN78iMBv\"\n },\n \"fields\": [\n {\n \"ref\": \"cf81e0bf-7f04-4d29-a2a2-c99b47c1cedd\",\n \"type\": \"statement\",\n \"title\": \"This self-declaration form is put together in alignment with World Health Organization's Covid-19 outbreak guidelines. \\n\\nKeep us informed so that we can help you stay safe in these challenging times\",\n \"properties\": {\n \"hide_marks\": false,\n \"button_text\": \"Continue\"\n }\n },\n {\n \"ref\": \"bb5aa51c-e8d4-4f47-8371-3856c6dea423\",\n \"type\": \"email\",\n \"title\": \"What's your email id?\",\n \"properties\": {\n \"description\": \"This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"ea4ee3b0-5dc3-4c66-9071-b2dde0dea41a\",\n \"type\": \"phone_number\",\n \"title\": \"What's your mobile number?\",\n \"properties\": {\n \"description\": \"This will help us keep you informed in the event a COVID-19 positive case is discovered in our premises\",\n \"default_country_code\": \"US\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"094fd986-95bf-4ff5-9a42-4ad25145fe11\",\n \"type\": \"short_text\",\n \"title\": \"Which doctor are you here to consult today?\",\n \"properties\": {\n \"description\": \"(Doctor name)\"\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"5e18502f-3a4e-4894-9f03-dce6d78e0bb5\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you travelled to an international or domestic location in the past 3 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/fkaRQkYF6sdw\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"6d60fc0e-6645-4966-84d8-10b90e37960e\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"0e002a1c-25aa-4eae-9563-66e2fe40665a\",\n \"label\": \"No\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"b99521ba-9e6f-4357-8ed5-acf6740833d7\",\n \"type\": \"multiple_choice\",\n \"title\": \"What's your gender?\",\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"fe283bb3-7f06-43d1-83e8-dd48e663e904\",\n \"label\": \"Male\"\n },\n {\n \"ref\": \"bc0f3b2e-786d-41c4-b1e1-771878288ea5\",\n \"label\": \"Female\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": false\n }\n },\n {\n \"ref\": \"5a0f2b02-2302-4029-bfaf-ddb3d9446713\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you experienced any of these symptoms in the last 2 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/Wy9iM7YpWDKf\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"6c24ccce-a159-4cf6-866c-9cd4d3bb4650\",\n \"label\": \"Cold and cough\"\n },\n {\n \"ref\": \"c7955809-de34-43df-b116-102e16c85a86\",\n \"label\": \"Running nose\"\n },\n {\n \"ref\": \"cca8c5c0-7536-4e95-bd88-4444066c2a39\",\n \"label\": \"Shortness of breath\"\n },\n {\n \"ref\": \"1539a61e-73d8-48cb-a04d-3a61b082d689\",\n \"label\": \"Sore throat\"\n },\n {\n \"ref\": \"80afef6d-fb4e-4dda-a973-99e9353dbb9a\",\n \"label\": \"Fever\"\n },\n {\n \"ref\": \"e4af5729-08f4-433b-9e5c-c7fbf64cba7a\",\n \"label\": \"Unsure\"\n },\n {\n \"ref\": \"e1b0c83f-704a-4526-be14-0b31572b84c1\",\n \"label\": \"None of the above\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"ce43e9ac-2e20-4318-9a45-e2143f29c13b\",\n \"type\": \"multiple_choice\",\n \"title\": \"Do any of your family members have the above symptoms?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/bYducJ2kQEzi\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"b7cb8a79-e557-4a3c-990c-9ac835c8c7c7\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"90e2efeb-a40d-4540-a1b7-b5c0bfd177d1\",\n \"label\": \"No\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"083443e3-69e4-4bd8-a84a-05e6d14dabed\",\n \"type\": \"multiple_choice\",\n \"title\": \"Have you been in contact with someone with flu in the past 2 weeks?\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/QkbPABHjUrqQ\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"choices\": [\n {\n \"ref\": \"a0d57cef-6603-45b1-9cac-eb7e6387c76a\",\n \"label\": \"Yes\"\n },\n {\n \"ref\": \"88a8788c-adcf-47ad-af25-890ae332da53\",\n \"label\": \"No\"\n },\n {\n \"ref\": \"0b3f78b9-569e-4bb1-9fb9-c62ca505f466\",\n \"label\": \"Not sure\"\n }\n ],\n \"randomize\": false,\n \"allow_other_choice\": false,\n \"vertical_alignment\": true,\n \"allow_multiple_selection\": false\n },\n \"validations\": {\n \"required\": true\n }\n },\n {\n \"ref\": \"00a0cdbb-12a2-4ce1-9e0d-806996936828\",\n \"type\": \"statement\",\n \"title\": \"I declare all above to be true. I am aware that I may be held liable for knowingly providing incorrect information\",\n \"properties\": {\n \"hide_marks\": false,\n \"button_text\": \"Continue\"\n }\n }\n ],\n \"settings\": {\n \"meta\": {\n \"allow_indexing\": false\n },\n \"is_trial\": false,\n \"language\": \"en\",\n \"is_public\": true,\n \"progress_bar\": \"percentage\",\n \"notifications\": {\n \"self\": {\n \"enabled\": true,\n \"message\": \"Your typeform {{form:title}} has a new response:\\n{{form:all_answers}}\\n\\nTeam Beaconstac\\n\",\n \"subject\": \"Typeform: New response for {{form:title}}\",\n \"recipients\": [\n \"hari.a+5678@mobstac.com\"\n ]\n },\n \"respondent\": {\n \"enabled\": true,\n \"message\": \"Hello,\\nWe’ve received your submission.\\n{{form:all_answers}}\\nThank you & have a nice day!\",\n \"subject\": \"Typeform: Thank you for filling out {{form:title}}\",\n \"recipient\": \"{{field:bb5aa51c-e8d4-4f47-8371-3856c6dea423}}\"\n }\n },\n \"show_progress_bar\": true,\n \"are_uploads_public\": false,\n \"show_typeform_branding\": false\n },\n \"variables\": {\n \"score\": 0\n },\n \"workspace\": {\n \"href\": \"https://api.typeform.com/workspaces/11932656\"\n },\n \"welcome_screens\": [\n {\n \"ref\": \"c4474bbc-156f-4e1d-b585-057bd0461eaf\",\n \"title\": \"We are dedicated to prevent the spread of the novel coronavirus.\\n\\nFill in the form to get access & enjoy a risk-free time inside!\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/ctp4n62CsDMm\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_text\": \"GET STARTED\",\n \"show_button\": true\n }\n }\n ],\n \"thankyou_screens\": [\n {\n \"ref\": \"8778f1ad-dfed-4e46-8c82-7c537acfcb63\",\n \"title\": \"Present this screen at the entrance to get access\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/btDfqrgjA7wN\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_mode\": \"reload\",\n \"button_text\": \"again\",\n \"share_icons\": false,\n \"show_button\": true\n }\n },\n {\n \"ref\": \"f4b1a41d-c28a-4b8c-941b-a681f4c25e2b\",\n \"title\": \"Based on your answers, we have a few additional queries, please speak with our representative\",\n \"attachment\": {\n \"href\": \"https://images.typeform.com/images/yvbArZPNmXj5\",\n \"type\": \"image\"\n },\n \"properties\": {\n \"button_mode\": \"reload\",\n \"button_text\": \"again\",\n \"share_icons\": false,\n \"show_button\": true\n }\n },\n {\n \"ref\": \"default_tys\",\n \"title\": \"Done! Your information was sent perfectly.\",\n \"properties\": {\n \"share_icons\": false,\n \"show_button\": false\n }\n }\n ]\n },\n \"title\": \"new Title\",\n \"form_id\": \"EN78iMBv\",\n \"form_type\": \"TY\",\n \"sms_structure\": {},\n \"email_structure\": {},\n \"organization\": 15406\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/forms/54024/","description":"Updates the Feedback Form specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","forms","54024",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b18abde-012c-42fb-9edf-05dc23014329"},{"name":"Fetch Form responses","id":"a778eff3-a893-45f2-b9b7-1ce7d379e6bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/forms/54024/responses/?page_size=5&since=1587468650975&until=1604687400000&timezone=Asia/Kolkata&organization={{ORG_ID}}","description":"Fetch Form responses for a given Form based on its ID.
\n","urlObject":{"path":["2.0","forms","54024","responses",""],"host":["https://api.uniqode.com/api"],"query":[{"description":{"content":"No of responses in a single page
\n","type":"text/plain"},"key":"page_size","value":"5"},{"description":{"content":"Timestamp starting date in epoch millis
\n","type":"text/plain"},"key":"since","value":"1587468650975"},{"description":{"content":"Timestamp end date in epoch millis
\n","type":"text/plain"},"key":"until","value":"1604687400000"},{"description":{"content":"Timezone
\n","type":"text/plain"},"key":"timezone","value":"Asia/Kolkata"},{"description":{"content":"Organization ID
\n","type":"text/plain"},"key":"organization","value":"{{ORG_ID}}"}],"variable":[]}},"response":[],"_postman_id":"a778eff3-a893-45f2-b9b7-1ce7d379e6bc"}],"id":"0e10f6cf-1f70-47cd-bb01-49cf7832ebfb","description":"Create Feedback Forms for collecting information for surveys, marketing etc from your customers.
\nFeedback Form attributes:
List all the Webhooks in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","organizationwebhooks",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa649fe7-48f0-4624-8bdc-8c8fecbb81d8"},{"name":"Create a Webhook","id":"0748cc70-250f-46c8-b9c8-d9e52d661900","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"organization\": {{ORG_ID}},\n \"webhook_authorization\": {},\n \"qr_code_events\": {\n \"create\": true,\n \"update\": false,\n \"delete\": false,\n \"view\": true\n },\n \"nfc_tag_events\": {\n \"update\": true,\n \"delete\": false,\n \"view\": true\n },\n \"beacon_events\": {\n \"update\": false,\n \"view\": true,\n \"notification_sent\": true\n },\n \"geofence_events\": {\n \"create\": true,\n \"update\": false,\n \"view\": true,\n \"notification_sent\": true\n },\n \"form_events\": {\n \"form_response_submitted\": true\n },\n \"url\": \"https://enyryc8hknrscun.m.pipedream.net\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/organizationwebhooks/","urlObject":{"path":["2.0","organizationwebhooks",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0748cc70-250f-46c8-b9c8-d9e52d661900"},{"name":"Retreive a webhook","id":"83146445-b649-4d7e-ae73-5beafbf4bd06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/organizationwebhooks/72/","description":"Retrieves the details of the specified Webhook. You need only supply the unique Webhook identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","organizationwebhooks","72",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"83146445-b649-4d7e-ae73-5beafbf4bd06"},{"name":"Update a Webhook","id":"c303d7c1-f34f-42be-a524-f3598810a452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"organization\": {{ORG_ID}},\n \"webhook_authorization\": {},\n \"qr_code_events\": {\n \"create\": false,\n \"update\": false,\n \"view\": true\n },\n \"nfc_tag_events\": {\n \"update\": true,\n \"delete\": false,\n \"view\": true\n },\n \"beacon_events\": {\n \"update\": false,\n \"view\": true,\n \"notification_sent\": true\n },\n \"geofence_events\": {\n \"update\": true\n },\n \"form_events\": {\n \"form_response_submitted\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/organizationwebhooks/72/","urlObject":{"path":["2.0","organizationwebhooks","72",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c303d7c1-f34f-42be-a524-f3598810a452"}],"id":"7034f0c0-c38f-496c-8554-110fb007d841","description":"A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. It can be used to connect different services with Uniqode and automate certain processes.
\nWebhook Attributes:
Events supported include:
\nqr_code_events) - create, update, delete, viewnfc_tag_events) - update, viewbeacon_events) - update, delete, view, notification_sentgeofence_events) - create, update, view, notification_sentform_events) - form_response_submittedList all the Places in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","places"],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c31cf451-cf4a-4613-9ef6-1ffe7b087628"},{"name":"Create new Place","id":"3951fab0-9d67-4e84-a8aa-18d44ddca63f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Uniqode\",\n \"latitude\": 40.7532635,\n \"longitude\": -73.9776275,\n \"place_id\": \"ChIJlTisbQJZwokRRDFLYZOmLC4\",\n \"address\": \"450 Lexington Ave, New York, NY 10017, USA\",\n \"business_cover_url\": \"https://static.uniqode.com/assets/img/uniqode-registered-blue.svg\",\n \"business_icon_url\": \"https://digitalcommunicationsgroup.com/wp-content/uploads/2020/10/beaconstac-logo.png\",\n \"business_color\": \"2595FF\",\n \"organization\": {{ORG_ID}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/places/","description":"Creates a new Place based on the parameters passed in the request body.
\n","urlObject":{"path":["2.0","places",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3951fab0-9d67-4e84-a8aa-18d44ddca63f"},{"name":"Retreive a Place","id":"45140e06-067f-4c1b-a90a-35ce9db6b827","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/places/19855/","description":"Retrieves the details of the specified Place. You need only supply the unique Place identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","places","19855",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"45140e06-067f-4c1b-a90a-35ce9db6b827"},{"name":"Update an existing place","id":"4cf24bf4-7cc2-4a33-8d88-239cf596b7b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\",\n \"organization\": {{ORG_ID}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/places/39680/","description":"Updates the Place specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","places","39680",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"4cf24bf4-7cc2-4a33-8d88-239cf596b7b0"}],"id":"f14f9727-5c99-456d-ba04-147b544346d0","description":"Place objects allow you to perform actions on Places in your account. You can create a new place, update an existing place, retreive a place or view all places in your account from the Place object.
\n| Field | Type | Description |\n|---|---|---|---|\n| id | integer | false | read only | Unique identifier for the object |\n| name | string | required | false | The name of the place |\n| organization | integer | required read only
Organization id |\n| latitude | float | Latitude |\n| longitude | float | Longitude |\n| place_id | string | Google Place ID |\n| address | string | Address of the place |\n| beacons | list[object] |read only
Beacon data associated with place id. Only available in List |\n| beacon_count | integer | Beacon count |\n| default_place | boolean | read only
Indicated whether the place is a default place |\n| business_icon_url | string | Business Icon URL (Used in NearBee) |\n| business_cover_url | string | Business Cover URL(Used in NearBee) |\n| business_color | string | Business Color(Used in NearBee) |\n| created | timestamp | Created timestamp |\n| updated | timestamp |read only
Last updated timestamp |
\n","event":[{"listen":"prerequest","script":{"id":"592058bb-57c6-48ba-9133-5d4ccb43283f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ee8b66f8-dc3d-4375-8913-c02974cd646f","type":"text/javascript","exec":[""]}}],"_postman_id":"f14f9727-5c99-456d-ba04-147b544346d0"},{"name":"Bulk QR Codes [Deprecated]","item":[{"name":"List Bulk QR Code collections","id":"03125ace-aada-47c0-ab84-0ddc6c3b6a4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/bulkqrcodes/","description":"List all the BulkQRCode objects in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","bulkqrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"03125ace-aada-47c0-ab84-0ddc6c3b6a4e"},{"name":"Create a Bulk QR Code collection","id":"2dd93d6c-c23f-4f66-bc2a-cc5ef622f5d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"organization","value":"{{ORG_ID}}","description":"The organization ID for the Bulk QR Code collection
\n","type":"text"},{"key":"name","value":"Sample Bulk QR Code collection","description":"Name of the collection
\n","type":"text"},{"key":"file","description":"CSV file to create the QR Codes
\n","type":"file","value":null},{"key":"qr_type","value":"1","description":"Static type
\n","type":"text"},{"key":"qr_data_type","value":"1","description":"For website type Bulk QR Code collection
\n","type":"text"},{"key":"error_correction_level","value":"1","description":"Error correction level for the QR Code images
\n","type":"text"},{"key":"size","value":"1024","description":"Size of the QR Code images
\n","type":"text"}]},"url":"https://api.uniqode.com/api/2.0/bulkqrcodes/","description":"Creates a Landing Page based on the parameters passed in the request body. Request body data needs to be passed in the multipart-form-data format. You also need to pass the data for size and error correction level for the QR Codes in the request data.
\n","urlObject":{"path":["2.0","bulkqrcodes",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2dd93d6c-c23f-4f66-bc2a-cc5ef622f5d6"},{"name":"Retreive a Bulk QR Code collection","id":"89e1a863-995f-4d8a-a939-6a7fad5f372d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/bulkqrcodes/763/","description":"Retrieves the details of the specified BulkQRCode object. You need only supply the unique BulkQRCode identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","bulkqrcodes","763",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"89e1a863-995f-4d8a-a939-6a7fad5f372d"},{"name":"Update a Bulk QR Code collection","id":"1edb13c5-cf22-4b16-91fd-6608e6b08b73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"id\": 763,\n \"attributes\": {\n \"color\": \"#000000\",\n \"margin\": 80\n },\n \"name\": \"Updated Bulk QR Code collection\",\n \"organization\": 15406,\n \"media\": 146510\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/bulkqrcodes/763/","description":"Updates the BulkQRCode object specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","bulkqrcodes","763",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1edb13c5-cf22-4b16-91fd-6608e6b08b73"}],"id":"1b4ec32a-2339-4627-9630-1c84d9cc1a35","description":"This object has been deprecated. Please use Bulk QR codes V2 under the QR codes section to generate QR codes in bulk.
\nBulkQRCode objects allow you to perform actions on create a collection of QR Codes in a single request. You can create a QR Code collection, retrieve or update individual QR Code collections as well as a list of all your QR Code collections.
\nThe behaviour of BulkQRCode objects is currently restricted to static QR Codes only.
\nBulkQRCode objects support all values for attributes supported by the QRCode object. You can also pass individual attribute data in the CSV file used to create the Bulk QR Code collection, this allows you to create QR Codes with different designs in a single collection.
The supported data types for Bulk QR Code collections include:
\nOpening the storage_url downloads the zipped Bulk QR Code collection. The collection consists of the QR Code images in JPEG, PDF, PNG and SVG formats.
List all the Organization objects in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","organizations",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"057865ac-cbf4-48c5-b50c-e26e9120ea6a"},{"name":"Create Child Organization","id":"d6c4da74-886d-4843-8612-34b7cb65536e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Child Org\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/organizations/","description":"Creates an Organization based on the parameters passed in the request body.
\n","urlObject":{"path":["2.0","organizations",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6c4da74-886d-4843-8612-34b7cb65536e"},{"name":"Retreive an Organization","id":"bf749742-528e-40b9-849e-b19be234251c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"url":"https://api.uniqode.com/api/2.0/organizations/15406/","description":"Retrieves the details of the specified organization. You need only supply the unique organization identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","organizations","15406",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf749742-528e-40b9-849e-b19be234251c"},{"name":"Update Organization","id":"f8c6b704-665b-4d58-a979-f07938875971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Updated name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/organizations/15406/","description":"Updates the Organization specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","organizations","15406",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8c6b704-665b-4d58-a979-f07938875971"},{"name":"Count of objects associated with the Organization","id":"3a6aae27-92b9-479c-b51a-381cd068aaff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/organizations/{{ORG_ID}}/counts/","description":"Returns the counts of individual objects associated with the Organization.
\n","urlObject":{"path":["2.0","organizations","{{ORG_ID}}","counts",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a6aae27-92b9-479c-b51a-381cd068aaff"}],"id":"9bc86b82-6e43-49ae-b685-cf5e9120a719","description":"Organization objects are the main reference to all other objects in your account. You can list all organizations associated with your account, retreive or update an organization. You will need to have an Enterprise account or Reseller access to be able to create Organizations.
\nOrganization attributes:
Feature Permissions attributes:
Feature Permission objects represent the permissions available to users belonging to the Organization. For enabling a feature, kindly contact support@uniqode.com.
List all the User objects associated with your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","users",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb7ecafb-a7b5-412b-8e8a-d7bf3b7efb73"},{"name":"Create a User","id":"1d300be9-ee22-41f3-91b8-8645d572d816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"customer_plan\": \"EN\",\n \"user_group\": \"AD\",\n \"organization\": 1264,\n \"username\": \"john@uniqode.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/users/add/","description":"Creates a User based on the parameters passed in the request body.
\n","urlObject":{"path":["2.0","users","add",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d300be9-ee22-41f3-91b8-8645d572d816"},{"name":"Retreive a User","id":"fa00408e-615a-4b75-b13e-761a3d581f04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/users/15189/","description":"Retrieves the details of the specified User. You need only supply the unique User identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","users","15189",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa00408e-615a-4b75-b13e-761a3d581f04"},{"name":"Update a User","id":"b9780c1c-8ad9-460b-b353-fa6f744253c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/users/15189/","description":"Updates the User specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","users","15189",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9780c1c-8ad9-460b-b353-fa6f744253c9"}],"id":"787c2c4a-b808-452b-9d2d-956e0d3e77f9","description":"User objects allow you to add multiple users who can interact with the objects in your account or modify your user credentials. You can list all users associated with your account, retreive or update a user. You will need to have an Enterprise account or Reseller access to be able to create Organizations.
\nUser attributes:
List all the Media objects in your account. You can filter and paginate your results using query params.
\nReturns paginated response consising of:
\n","urlObject":{"path":["2.0","media",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d100b47-592a-46fe-89eb-2bc93f4beef4"},{"name":"Create Media object","id":"e99800fe-3e53-456e-9545-2eda826ff063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"organization\": {{ORG_ID}},\n \"public\": true,\n \"name\": \"Sample Media object\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/media/","description":"Creates a Media object which can be used to upload files in Uniqode and returns the appropriate policy details for you to upload your files to our system.
\nResponse data
\n","urlObject":{"path":["2.0","media",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e99800fe-3e53-456e-9545-2eda826ff063"},{"name":"Retreive Media object","id":"3c532a00-ae22-4a8f-b3c5-aa3582327608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{TOKEN}}","type":"text"}],"url":"https://api.uniqode.com/api/2.0/media/153382/","description":"Retrieves the details of the sprcified Media object. You need only supply the unique Media identifier that was returned upon listing.
\n","urlObject":{"path":["2.0","media","153382",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c532a00-ae22-4a8f-b3c5-aa3582327608"},{"name":"Update Media object","id":"0ccf1ff9-10ac-43ce-bc3b-86c400dd44c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Token {{TOKEN}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"PDF E-book\",\n \"content_type\": \"application/pdf\",\n \"visible\": true,\n \"typeform_compatible\": false,\n \"organization\": {{ORG_ID}}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.uniqode.com/api/2.0/media/153382/","description":"Updates the Media specified based on the ID by setting the values of the parameters passed. Any parameters not provided will be left unchanged. However, the request should contain the required fields.
\n","urlObject":{"path":["2.0","media","153382",""],"host":["https://api.uniqode.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ccf1ff9-10ac-43ce-bc3b-86c400dd44c4"}],"id":"669fbea9-32ee-4510-b50d-56c4e67a590b","description":"Media objects allow you to upload files such as images, documents into Uniqode and use them with campaigns through Beaconstac products. You can create a Media object, retrieve or update individual Media objects as well as a list of all the Media objects in your account.
\nMedia object:
Uniqode uses the S3 service from Amazon Web Services to store files. In order to upload a file to Uniqode, use the Media API to first create a Media object, which returns the policy details and necessary information required to upload a file to Uniqode. Once upload is completed, update the Media object with the appropriate information so that you can reference the object to access the files in the future.
\n","event":[{"listen":"prerequest","script":{"id":"152fb502-d863-4f23-8451-0af6fa2f5b83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2e91f1e-7c79-4b86-b102-40ae0718e8ce","type":"text/javascript","exec":[""]}}],"_postman_id":"669fbea9-32ee-4510-b50d-56c4e67a590b"}],"event":[{"listen":"prerequest","script":{"id":"c386292a-c0c4-43d3-bc0d-b8201d9be5d4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cbe9d6bf-7067-44ac-9786-76b57120d2e0","type":"text/javascript","exec":[""]}}],"variable":[{"id":"2f4953e5-363c-4744-8e63-6b32036f43f5","key":"AUTH_TOKEN","value":""},{"id":"0c3e784a-38b9-4b41-a34b-a3cf54cb0e94","key":"API_BASE","value":"https://api.uniqode.com/api"},{"id":"0e9c1ae0-4c97-4e52-81bb-1d820bcdca85","key":"API_VERSION","value":"2.0"},{"id":"1cb9623c-50c5-45b8-a171-215951475d29","key":"REPORTING_BASE","value":"https://api.uniqode.com/reporting"},{"id":"45249e46-b97d-4a5b-8bf9-73873ddcfcbd","key":"REPORTING_VERSION","value":"2.0"}]}