{"info":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","description":"

The Checkbox API is a REST-based JSON API that utilizes OAuth and JWT. The documentation on this page is organized by API Endpoint and code examples are provided in some of the top programming languages.

To use our API you will need an active Checkbox 8 Online account OR Checkbox 8 On-Premises installation. The API documentation provided is valid for both On-Premises and Checkbox Online customers.

API Endpoints for Checkbox Online

\n\n

Checkbox Online customers will use their account name where instructed while server customers can leave the parameter blank. Each different region for Checkbox Online has it's own API URL. Please refer to the table below for your region's URL. The API is only available for Checkbox Online customers with a professional plan or higher. There are no \"hard-limits\" on the amount of API requests you can make, however mis-use of the API can cause the API to be disabled.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Application URL	Region	API URL
https://app.checkbox.com	United States	https://api.checkbox.com/v1
https://app.checkbox.ca	Canada	https://api.checkbox.ca/v1
https://app.ckbxeu.com	Europe	https://api.ckbxeu.com/v1
https://app.checkboxau.com	Australia	https://api.checkboxau.com/v1
https://app.checkboxuk.com	United Kingdom	https://api.checkboxuk.com/v1

To access the API you will want to use {{API_URL}}/{{Sub_Domain}}/{{Endpoint}}

It is very important to include the version number in the URL of your requests. Without the version number the request will return an error that your subdomain is invalid.

API Endpoints for Checkbox On-Premise/Server/OEM

\n\n

On-premise customers have no limits on API usage.

The correct URL to use is:
{{YOUR_API_URL}}/v1/{{ENDPOINT}

(replace {{YOUR_API_URL}}) with the URL specified for your API site during installation, including http or https)

Important Note for Developers

\n\n

Both the Checkbox Admin App and the Checkbox Take Survey App utilize these exact API calls. Therefore, if these applications work but your API calls do not, it is likely an issue with your code.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3565672","collectionId":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","publishedId":"RWaHxUgU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-09-11T15:40:45.000Z"},"item":[{"name":"Authentication","item":[{"name":"Authenticate","id":"865f947d-31b0-45ff-83fd-8ec8659b9026","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{Username}}","type":"text"},{"key":"password","value":"{{Password}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"ExternalApi","type":"text","uuid":"64509a5b-484b-457b-9463-1098efb9d195"}]},"url":"{{URL}}/{{ACCOUNT_NAME}}/oauth2/token","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","oauth2","token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"25d3435a-d6ae-4774-a26d-d3fdfd11b08d","name":"Authenticate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"{{Username}}","type":"text"},{"key":"password","value":"{{Password}}","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"client_id","value":"ExternalApi","type":"text","uuid":"45d6b5f1-fdb9-4374-95f9-9fcf66a447a2"}]},"url":"{{URL}}/{{ACCOUNT_NAME}}/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"510","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json;charset=UTF-8","description":"The mime type of this content"},{"key":"Date","value":"Thu, 02 Aug 2018 19:04:35 GMT","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","description":"A name for the server"},{"key":"X-Powered-By","value":"ASP.NET","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9\",\n \"token_type\": \"bearer\",\n \"expires_in\": 43199,\n \"user_name\": \"admin\",\n \"roles\": \"System Administrator\",\n \"account_name\": \"apiaccount\",\n \"hosts\": \"localhost\"\n}"}],"_postman_id":"865f947d-31b0-45ff-83fd-8ec8659b9026"}],"id":"2f19d57d-e3ec-4879-8f3d-a82846332877","description":"

In order to utilize the API you will need to first retrieve an json web token from the API. This can be done using the {ACCOUNT_NAME}/oauth2/token endpoint passing in your username and password. An example request can be found on the right hand side.

Once the request has been verified you will receive an authentication token that you will pass in the authentication header in subsequent requests. This token will expire if not used and you may need to request a new one.

Enable API Access in Your Checkbox Account

Before you can use the API, you need to enable external API access in your account:

Log in to your Checkbox account
\n
Navigate to Account settings → System preferences → Authentication settings
\n
Enable the checkbox for external API access
\n
Save your settings
\n

⚠️ Important: This step must be completed before attempting API authentication, or your requests will fail.

\n","event":[{"listen":"prerequest","script":{"id":"4352b838-eee1-4e28-bf65-188047552bf2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9d4a751c-51bb-46eb-8a0e-6292c0876660","type":"text/javascript","exec":[""]}}],"_postman_id":"2f19d57d-e3ec-4879-8f3d-a82846332877","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Roles","item":[{"name":"Get System Roles","id":"6250a782-a084-49a8-befe-e235d8aa269a","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/roles","description":"

This endpoint returns all the roles available to users. These roles can then be added to a contact / user to grant them ability to complete different actions in Checkbox. More detailed information on what each role can do can be found in our end user documentation.

Roles in Checkbox control what a contact / user has access to do, not what they can access. Assign roles to give users the ability to complete certain actions in Checkbox. To grant them access to content in Checkbox you will need to grant them specific access to that content using the access lists. Access list methods can be found under each individual resources method list.

\n","_postman_id":"a527dec8-1d90-494f-93c2-b4e0aaca1fd0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"License Limits","item":[{"name":"Get License Limits","id":"9c39dc81-44f9-46a3-b729-ee4fee8ebe8f","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/licensing/limits","description":"

This endpoint can be utilized to retrieve the full list of limits on your account.

Potential limits are :

[[Table including potential license limits]]

This endpoint can be utilized to retrieve information about a specific license limit. This can be used to monitor a specific limit like emails so that you do not attempt to send out more email invitations then you have available.

This endpoint can be utilized to get licensing details.

Checkbox Hosted and On Premise accounts are bound to limits based on their license type. This endpoint can be utilized to poll those limits for their current status.

Potenital limits for Checkbox Hosted and On Premises customers may differ. For instance Checkbox Hosted customers have limits on number of emails they can send while on premises editions have unlimited emails.

\n","event":[{"listen":"prerequest","script":{"id":"6a666a1b-6478-4c5f-be3d-2d5ab48a1ea4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e90b1f52-7af5-44d2-8b8f-d47a8af0cf56","type":"text/javascript","exec":[""]}}],"_postman_id":"268deb29-7d1c-4529-aebe-1dc8ada0687c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Contacts","item":[{"name":"Contacts","item":[{"name":"Get Contacts","id":"f115854a-d83b-444d-955c-c9a8fc063e5c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}/{{ACCOUNT_NAME}}/contacts?search_text={string}&sort_ascending={bool}&page_size={int}&page_num={int}","description":"

This endpoint will return a paged, filtered list of contacts that the authenticated user has access to. System administrators by default have access to all contacts, any lower role will only have access to contacts that are part of groups that they have access to. To grant a user access to all contacts you can grant them access to the \"Contact List\" which is the complete list of contacts in the Checkbox account.

Used for searching by name

\n","type":"text/plain"},"key":"search_text","value":"{string}"},{"description":{"content":"

Sort list by ascending order, default true

\n","type":"text/plain"},"key":"sort_ascending","value":"{bool}"},{"description":{"content":"

Number of contacts per page returned

\n","type":"text/plain"},"key":"page_size","value":"{int}"},{"description":{"content":"

Page number to be returned

\n","type":"text/plain"},"key":"page_num","value":"{int}"}],"variable":[]}},"response":[{"id":"adab9009-5664-4948-98a5-d2beb565adc0","name":"Get Contacts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/contacts?search_text={string}&sort_ascending={bool}&page_size={int}&page_num={int}","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","contacts"],"query":[{"key":"search_text","value":"{string}","description":"Used for searching by name"},{"key":"sort_ascending","value":"{bool}","description":"Sort list by ascending order, default true"},{"key":"page_size","value":"{int}","description":"Number of contacts per page returned"},{"key":"page_num","value":"{int}","description":"Page number to be returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2451","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 02 Aug 2018 20:10:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 2,\n \"items\": [\n {\n \"id\": \"user12\",\n \"email\": \"w@bb.com\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"user11\",\n \"email\": \"w@bb.com\",\n \"status\": \"Active\"\n }\n ],\n \"paging_info\": {\n \"page_size\": 0,\n \"page_num\": 1\n },\n \"has_next\": false,\n \"has_previous\": false\n}"}],"_postman_id":"f115854a-d83b-444d-955c-c9a8fc063e5c"},{"name":"Get Contact","id":"3a928146-0d37-4467-940d-74197ec9dfa1","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/contacts/useradministrator","description":"

This endpoint will return the contact data for a single contact specified by its contact ID. This method will only return data for the contact if the authenticated user has access to the contact being requested.

This will return group memberships, role data, and profile property data for the contact requested.

This endpoint will create a contact with the id, email, and password specified. It will also add the contact to the specified group IDs.

The password field is optional. If no password is provided the system will auto generate one.

Group ID list is optional for users with access to the \"Contact List\". Any user without access to the \"Contact List\" must provide a group ID for a group they have access to or the contact will not be created.

This endpoint can be utilized to edit a contacts id, email or password. It can also be used to enable or disable the contacts account.

Contact profile property data can be edited using the edit contact profile data endpoint documented below.

This endpoint will alllow you to delete a contact. Please be aware that deleting a contact through the API will not request confirmation and cannot be undone.

Deleting a contact will hard delete data that cannot be restored. Make sure that the contact you are deleting is the corect contact and that you are sure you want to delete them.

This endpoint will retrieve a list of surveys that the contact has opted out of taking.

This endpoint will allow you to retrieve the groups that a contact is a member of. This will return all groups the contact is a member of wether or not you have access to those groups.

You can only retrieve this data if you have access to the contact.

This endpoint will allow you to add a contact to a group. This method will only work if you have access to the contact and the group that you are attempting to add the contact to.

The group ID should be passed into the body as a string as shown in the example request.

This endpoint will allow you to remove a contact from a group. In order to do this you will need both permissions over the contact and the group that you are attempting to remove the contact from.

This endpoint will retrieve the list of roles that a contact has applied to them.

This endpoint will allow you to add a role to a contact. Roles can only be added one at a time using the role name as a string in the body of the request.

Only a system administrator can add the system administrator role to a user.

This endpoint will allow you to overwrite a contact roles with a new set of roles. This will remove all existing roles from a user and overwrite them with the new list of roles. You should utilize this method to remove roles from a user.

This endpoint can be utilized to pull profile data about the contact. This is only available if you have permissions over the contact.

Email address is not a profile property and will not be returned by this endpoint. To retrieve the email address of a user please use the Get Contact endpoint below.

This endpoint can be utilized to edit a profile property value for a contact. To update a profile value you must supply the entire profile with the changes you want to make. It is best to call the get profile property method first, then use that with your changes as the request for the PUT request.

This endpoint will retrive the access control list data for the \"Contact List\". This will only retrieve data if you have access to manage the contact list.

This endpoint will pull data on a specific ACL entry. This requires that you know the Entry ID in order to pull the specific entry.

This endpoint will let you add entries to the ACL for the \"Contact List\" this is only possible when you have \"Edit\" permission over the access list yourself.

Acceptable \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

Acceptable \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Name of a contact group that already exists
ContactGroupAD	Name of an active directory group (On-Premise Enterprise customers only)

This endpoint will allow you to edit an existing ACL entry. You can edit the ACL entry by submitting new data to it. The existing ACL entry will be overwritten with the new data passed into this request.

Acceptable \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

Acceptable \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Name of a contact group that already exists
ContactGroupAD	Name of an active directory group (On-Premise Enterprise customers only)

This endpoint will allow you to delete an existing ACL entry. This will only work if the ACL entry ID is an entry in the contact list, and if you have \"Edit\" permissions over the contact list.

This action will not prompt a confirmation and cannot be undone.

This endpoint will return the current default access policy for the contact list.

This endpoint will allow you to edit / update the default access policy for the contact list. This method will override the existing permissions and apply the new ones sent into the request.

Acceptable \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

The \"Contact List\" in Checkbox is the general list of all Contacts. This ACL is utilized to give a user access to the entire contact list regardless of the groups that they are in. You should only grant access to this list if the user requires access to all users not just those in the groups they have access to.

It is helpful to think of the \"Contact List ACL\" as a super group that all contacts are a part of.

Managing ACLs through the API is a very advanced procedure and should only be done by someone with knowledge of how permissions work using the interface of Checkbox. This should not be done by someone without intricate knowledge of permissions and security in Checkbox.

\n","event":[{"listen":"prerequest","script":{"id":"f4f937e9-490e-4ec3-85c3-9c2cd46db674","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b602b24a-87a1-4cfb-b1fd-9b17cdc25cbc","type":"text/javascript","exec":[""]}}],"_postman_id":"5fb9c7f7-4aed-4cf7-9248-dbf6acbace7f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Favorite Surveys","item":[{"name":"Get Favorite Surveys","id":"25f31f0d-a268-43ba-9952-c17a3871b3ab","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/contacts/me/favorite-surveys","description":"

This endpoint will allow you to retrieve a list of the currently authenticated users favorite surveys with meta data for that survey.

This endpoint will allow you to add a new favorite survey. This will only work if you have a permission higher then \"Take Survey\" for the existing survey.

This endpoint will allow you to remove a survey from your favorite survey list.

This endpoint will allow you to retrieve a list of the currently authenticated contacts favorite surveys and manage those favorites. You can only add a survey as a favorite if the currently authenticated user has access beyond \"Take Survey\" for that survey.

\n","_postman_id":"51ce791b-66cf-4b17-8c4e-8b6373ee6433","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"f159eb64-e226-48d7-a3e0-ade2f2d21d32","description":"

Contacts in Checkbox 7 take the place of \"Users\" in Checkbox 6. Contacts are both administrative users and survey respondents.

You can utilize this endpoint to retrieve contact data, edit and manage contacts as well as delete contacts.

\n","event":[{"listen":"prerequest","script":{"id":"0c925cbb-6c5f-412c-b2be-5d06aa977195","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8bab12a-810c-4ae2-861b-6dab20aaba3e","type":"text/javascript","exec":[""]}}],"_postman_id":"f159eb64-e226-48d7-a3e0-ade2f2d21d32","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Contact Groups","item":[{"name":"Contact Groups","item":[{"name":"Get Groups","id":"7904a938-5f7b-434a-a35e-3d077f9ad810","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/contact-groups?search_text={string}&sort_ascending={bool}&page_size={int}&page_num={int}","description":"

This endpoint will retrieve a list of contact groups that you have access to. The response will be a paged list which you can filter based on the group name. The \"id\" value will be utilized in other Contact Group methods.

*Checkbox Hosted customers should ignore the \"source\" values in the response. These pretain to active directory integration which is only available with the on-premise edition.

Used for searching by name

\n","type":"text/plain"},"key":"search_text","value":"{string}"},{"description":{"content":"

Sort list by ascending order, default tru

\n","type":"text/plain"},"key":"sort_ascending","value":"{bool}"},{"description":{"content":"

Number of groups per page returned

\n","type":"text/plain"},"key":"page_size","value":"{int}"},{"description":{"content":"

Page number to be returned

\n","type":"text/plain"},"key":"page_num","value":"{int}"}],"variable":[]}},"response":[{"id":"42d603f6-1857-4725-815d-3cbe5d610635","name":"Get Contact Groups","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/contact-groups?search_text={{string}}&sort_ascending={{bool}}&page_size={{int}}&page_num={{int}}","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","contact-groups"],"query":[{"key":"search_text","value":"{{string}}"},{"key":"sort_ascending","value":"{{bool}}"},{"key":"page_size","value":"{{int}}"},{"key":"page_num","value":"{{int}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"264","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 07 Aug 2018 18:34:36 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"total_count\":1,\"items\":[{\"can_edit\":true,\"id\":\"1021\",\"name\":\"wd1\",\"description\":\"\",\"member_count\":0,\"source\":{\"source_id\":\"checkbox-membership-provider\",\"source_type\":\"Checkbox\"}}],\"paging_info\":{\"page_size\":3,\"page_num\":1},\"has_next\":false,\"has_previous\":false}"}],"_postman_id":"7904a938-5f7b-434a-a35e-3d077f9ad810"},{"name":"Get Group","id":"86d38409-71cb-4f3e-8f05-a4a1282d6714","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/contact-groups/1021","description":"

This endpoint will return meta data for a single group specified. This will only return data if you have access to the contact group being requested.

This endpoint will allow you to create a group for contacts. You can then add members to the group using the POST method below.

This endpoint can be utilized to edit a contact groups name and or description. It cannot be utilized to add / remove members from a group.

[[This method is currently broken and needs to be fixed]]

This endpoint will allow you to delete a group from Checkbox.

Removing a group could alter permission for all contacts in the group. This action will not request a confirmation and cannot be undone.

This endpoint will return the contact information for the members of the group specified. This method will only work if you have access to the group.

Data returned is contact meta data, no profile or response information will be returned from this method.

This endpoint can be utilized to add a contact to a group. There is currently no way to bulk add contacts to a group but you can call this method in a loop with your contact list for quickly added new contacts to groups.

This endpoint will allow you to remove a contact from a group. This will not work for Active Directory user groups.

Removing a contact from a group could alter their permissions over other objects.

This endpoint will retrieve the access list entries for a specific group.

Possible \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will return data for a single ACL entry for the group. Both the groupId and the entryId are required for this to return valid data.

Possible \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to add an ACL entry to a contact group. This will only grant access if the user is in a role capable of the permission applied.

Possible \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts
View	View contacts in the contact list
Edit	Edit the Access Control List

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to edit the ACL entry for a group. This will overwrite the existing ACL entry with the new permissions supplied in the request.

Possible \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts Granting ManageMembership access will also grant access to \"View\"
View	View contacts in the contact list
Edit	Edit the Access Control List. Granting edit access will also grant access to \"View\"

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you delete an ACL entry for a group. This will only work if the entry exists for the group and you have \"Edit\" access for the group.

Deleting an ACL entry will not prompt for a verification and cannot be undone.

This endpoint will return the current default access policy for the contact group requested.

Possible \"Permission\" values for this method are : \nThis endpoint will allow you to edit / update the default access policy for the group specified in the request. This method will override the existing permissions and apply the new ones sent into the request.

Acceptable \"Permission\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
ManageMembership	Add and delete contacts Granting ManageMembership access will also grant access to \"View\"
View	View contacts in the contact list
Edit	Edit the Access Control List. Granting edit access will also grant access to \"View\"

This group of methods will allow the management of the security policies (ACL) of groups. You need \"Edit\" permission over the group for the ACL methods to return data or be a system administrator.

\n","event":[{"listen":"prerequest","script":{"id":"c1154645-c0c3-4958-acbc-d20c4577a3c5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"65f96894-cd24-4468-9b5c-0476e70c1021","type":"text/javascript","exec":[""]}}],"_postman_id":"b4a7d979-75a5-4c42-96d5-162a8f2d23c9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"c837118a-3ff6-4b7d-baec-32e54deb6c71","description":"

Contacts in Checkbox 7 take the place of \"Users\" in Checkbox 6. Contacts are both administrative users and survey respondents.

You can utilize these endpoints to retrieve data on and manage your contact groups including who has access to manage and update those groups.

\n","event":[{"listen":"prerequest","script":{"id":"0faba1ad-338c-4329-a8ba-30160e80aa27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1b619737-d74b-4264-9e08-614b9afb8c87","type":"text/javascript","exec":[""]}}],"_postman_id":"c837118a-3ff6-4b7d-baec-32e54deb6c71","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey Folders","item":[{"name":"Survey Folders","item":[{"name":"Get Survey Folders","id":"3a7efe5e-d874-47ff-912c-529840c81be0","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/survey-folders","description":"

This endpoint can be utilized to return a list of survey folders that the authenticated user has access to.

This endpoint can be utilized to pull the data for a specific folder based on its id.

This endpoint can be utilized to create a survey folder which can be utilized to help organize your surveys.

The description field is optional but the name field is required.

This endpoint can be utilized to edit an existing survey folders name and or description. This cannot be utilized to edit the content of the folder such as surveys in the folder.

This endpoint can be utilized to delete a survey folder. Any surveys currently in this folder will be moved to the root. This can cause a security risk if you delete a folder prior to moving our existing surveys.

This method will not request confirmation and cannot be undone. This method will return a status code of 200 OK and will not return any data in the response.

This endpoint can be utilized to retrieve data on the surveys currently in a folder. This will return survey meta data not any data related to items or responses.

Will return all surveys or only surveys marked favorite.

\n","type":"text/plain"},"key":"is_favorite","value":"{bool}"},{"description":{"content":"

Used for searching by name

\n","type":"text/plain"},"key":"search_text","value":"{string}"},{"description":{"content":"

Number of surveys per page returned

\n","type":"text/plain"},"key":"page_size","value":"{int}"},{"description":{"content":"

Page number to be returned

\n","type":"text/plain"},"key":"page_num","value":"{int}"}],"variable":[]}},"response":[{"id":"622dd5ae-912e-426e-ae34-6b85ea91ca75","name":"Get Surveys in Survey Folder","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/survey-folders/{{folderId}}/surveys?is_favorite={bool}&search_text={string}&page_size={int}&page_num={int}","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","survey-folders","{{folderId}}","surveys"],"query":[{"key":"is_favorite","value":"{bool}"},{"key":"search_text","value":"{string}"},{"key":"page_size","value":"{int}"},{"key":"page_num","value":"{int}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2600","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 11 Sep 2018 17:05:51 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 6,\n \"items\": [\n {\n \"id\": 1158,\n \"survey_folder_id\": 1069,\n \"name\": \"For_test Copy 1\",\n \"description\": null,\n \"status\": \"Published\",\n \"allow_edit_while_active\": true,\n \"custom_url\": null,\n \"firebase_url\": null,\n \"activation_start_date\": \"2017-05-09T15:00:00\",\n \"activation_end_date\": \"2017-05-26T02:20:00\",\n \"total_response_limit\": 20,\n \"per_respondent_response_limit\": 1,\n \"is_scored\": true,\n \"is_anonymized\": false,\n \"google_analytics_tracking_id\": \"\",\n \"security_type\": \"Public\",\n \"survey_password\": \"pas$$\"\n },\n {\n \"id\": 1434,\n \"survey_folder_id\": 1069,\n \"name\": \"For Testing\",\n \"description\": null,\n \"status\": \"Published\",\n \"allow_edit_while_active\": true,\n \"custom_url\": null,\n \"firebase_url\": null,\n \"activation_start_date\": null,\n \"activation_end_date\": null,\n \"total_response_limit\": null,\n \"per_respondent_response_limit\": null,\n \"is_scored\": false,\n \"is_anonymized\": false,\n \"google_analytics_tracking_id\": null,\n \"security_type\": \"Public\",\n \"survey_password\": \"12\"\n }\n ],\n \"paging_info\": {\n \"page_size\": 0,\n \"page_num\": 1\n },\n \"has_next\": false,\n \"has_previous\": false\n}"}],"_postman_id":"943ad7e7-0e78-4f88-9bc1-e1a519b1664c"}],"id":"0f2a0bf7-7d5d-4c17-b219-85840a05e103","_postman_id":"0f2a0bf7-7d5d-4c17-b219-85840a05e103","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey Folders ACL ","item":[{"name":"Get Survey Folder ACL","id":"eb721999-1bb9-41ac-a25c-b8a14c390b7d","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/survey-folders/1069/acl","description":"

This endpoint will retrieve the access control list data for the survey folder requested. This will only retrieve data if you have access to manage the survey folder.

This endpoint will pull data on a specific ACL entry. This requires that you know the Entry ID in order to pull the specific entry data.

This endpoint will let you add entries to the ACL for the survey folder requested. This is only possible when you have the \"SurveyFolderManage\" permission over the folder.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Manage	Manage the folder and its security
View	View the folder

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will let you add entries to the ACL for the survey folder requested. This is only possible when you have the \"SurveyFolderManage\" permission over the folder.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Manage	Manage the folder and its security
View	View the folder

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to delete an existing ACL entry. This will only work if the ACL entry ID is valid for the survey folder and if you have \"Manage\" permission over the folder.

This action will not prompt a confirmation and cannot be undone.

This endpoint will return the current default access policy for the survey folder requested.

This endpoint will update the current default access policy for the survey folder.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Manage	Manage the folder and its security
View	View the folder

This ACL is utilized to give a user access to a survey folder. This will not grant access to the surveys contained within the folder, just the folder itself. To grant access to surveys in the folder please utilize the survey ACL methods.

\n","event":[{"listen":"prerequest","script":{"id":"36a5334a-17ac-47e6-b182-a118ef688563","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9b2b6f80-7856-4c58-984c-50c873a6be99","type":"text/javascript","exec":[""]}}],"_postman_id":"069a5280-414e-49f0-a9a8-56381637aecc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"cfeebb26-8178-43ef-8d13-c74b44a382cc","description":"

Survey Folders in Checkbox can contain surveys or can be empty. You can utilize these endpoints to retrieve data on the survey folders, create new folders, and manage the permissions and access policies for the folders.

The main purpose of folders in Checkbox is for organization and for additional security.

\n","event":[{"listen":"prerequest","script":{"id":"bbbd2eb1-3cb9-4a48-abea-12debc24b070","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b75839fa-e277-4039-a175-8b43c6d12ee2","type":"text/javascript","exec":[""]}}],"_postman_id":"cfeebb26-8178-43ef-8d13-c74b44a382cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey List","item":[{"name":"Get Survey List","id":"aa204fdb-35a0-48ca-9c38-82902703feb4","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/survey-list?search_text={string}&folder_id={int}&is_favorite={bool}&page_size={int}&page_num={int}&status={enum}","description":"

This endpoint will return a list of surveys and folders matching the paging and filtering options sent in the request.

This endpoint can be utilized to return a list of surveys and folders you have access to.

\n","event":[{"listen":"prerequest","script":{"id":"f788fc73-0e13-410a-a17f-5a58d86b14ed","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a16909a5-0d3f-4252-b10c-9f605f313d7d","type":"text/javascript","exec":[""]}}],"_postman_id":"6840e11b-e65b-4ddc-922f-30dcd8e59b2f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey","item":[{"name":"Surveys","item":[{"name":"Get Surveys","id":"29827d3e-1758-44f1-ab35-b9507bb021fa","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys?search_text={string}&folder_id={int}&is_favorite={bool}&page_size={int}&page_num={int}","description":"

This endpoint can be utilized to pull a paged / filtered list of surveys that you have access to.

Used for searching by name

\n","type":"text/plain"},"key":"search_text","value":"{string}"},{"description":{"content":"

Filter by surveys in a specific folder

\n","type":"text/plain"},"key":"folder_id","value":"{int}"},{"description":{"content":"

Only return favorite surveys (default false)

\n","type":"text/plain"},"key":"is_favorite","value":"{bool}"},{"description":{"content":"

Number of surveys per page returned

\n","type":"text/plain"},"key":"page_size","value":"{int}"},{"description":{"content":"

Page number to be returned

\n","type":"text/plain"},"key":"page_num","value":"{int}"}],"variable":[]}},"response":[{"id":"95227218-883c-42dd-adf8-19006c2f05f2","name":"Get Surveys","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys?search_text={string}&folder_id={int}&is_favorite={bool}&page_size={int}&page_num={int}","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys"],"query":[{"key":"search_text","value":"{string}","description":"Used for searching by name"},{"key":"folder_id","value":"{int}","description":"Filter by surveys in a specific folder"},{"key":"is_favorite","value":"{bool}","description":"Only return favorite surveys (default false)"},{"key":"page_size","value":"{int}","description":"Number of surveys per page returned"},{"key":"page_num","value":"{int}","description":"Page number to be returned"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 30 Mar 2020 23:25:39 GMT"},{"key":"Content-Length","value":"1963"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 5,\n \"items\": [\n {\n \"id\": 1001,\n \"external_id\": \"1C357BF8-50F0-49B3-BD67-225605FE57BE\",\n \"survey_folder_id\": 1000,\n \"name\": \"Demographic Survey\",\n \"description\": null,\n \"status\": \"Published\",\n \"style_template_id\": 1032,\n \"created_by\": \"admin@checkbox.com\",\n \"created_date\": \"2012-03-27T07:32:23.707-05:00\",\n \"allow_edit_while_active\": true,\n \"custom_url\": \"demographic\",\n \"google_analytics_tracking_id\": \"\",\n \"security_type\": \"Public\"\n },\n {\n \"id\": 1004,\n \"external_id\": \"65707E88-127E-45C6-86DC-18B46FCBFB92\",\n \"survey_folder_id\": 1000,\n \"name\": \"Medical Intake Form\",\n \"description\": null,\n \"status\": \"Draft\",\n \"style_template_id\": 1029,\n \"created_by\": \"admin@checkbox.com\",\n \"created_date\": \"2012-03-27T07:34:21.043-05:00\",\n \"allow_edit_while_active\": true,\n \"custom_url\": \"medicalform\",\n \"google_analytics_tracking_id\": \"\",\n \"security_type\": \"Public\"\n },\n {\n \"id\": 1006,\n \"external_id\": \"A501FA00-E625-4324-95C9-2EAEFBF1CD56\",\n \"survey_folder_id\": 1000,\n \"name\": \"Retail Feedback Example\",\n \"description\": null,\n \"status\": \"Published\",\n \"style_template_id\": 1025,\n \"created_by\": \"admin@checkbox.com\",\n \"created_date\": \"2012-03-27T07:35:12.4-05:00\",\n \"allow_edit_while_active\": true,\n \"custom_url\": \"Chic-Boutique\",\n \"google_analytics_tracking_id\": \"\",\n \"security_type\": \"Public\"\n },\n {\n \"id\": 1007,\n \"external_id\": \"D056D6F8-A02A-4BCC-B304-DA02138014B7\",\n \"survey_folder_id\": 1000,\n \"name\": \"Website Satisfaction Survey\",\n \"description\": null,\n \"status\": \"Draft\",\n \"style_template_id\": 1024,\n \"created_by\": \"admin@checkbox.com\",\n \"created_date\": \"2012-03-27T07:35:25.407-05:00\",\n \"allow_edit_while_active\": true,\n \"custom_url\": \"website\",\n \"google_analytics_tracking_id\": null,\n \"security_type\": \"Public\"\n },\n {\n \"id\": 1010,\n \"external_id\": \"1483ED7E-4833-49EB-8ABF-6025C8EC7256\",\n \"survey_folder_id\": null,\n \"name\": \"Here's a sample survey you can edit\",\n \"description\": null,\n \"status\": \"Published\",\n \"style_template_id\": 1034,\n \"created_by\": \"admin@checkbox.com\",\n \"created_date\": \"2020-01-28T13:32:00.543-05:00\",\n \"allow_edit_while_active\": true,\n \"custom_url\": \"Sample-Survey\",\n \"google_analytics_tracking_id\": \"\",\n \"security_type\": \"AccessControlList\"\n }\n ],\n \"paging_info\": {\n \"page_size\": 0,\n \"page_num\": 1\n },\n \"has_next\": false,\n \"has_previous\": false\n}"}],"_postman_id":"29827d3e-1758-44f1-ab35-b9507bb021fa"},{"name":"Get Survey","id":"d9206ee4-9bc2-4e67-b106-971e61ee6f53","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1539","description":"

This endpoint can be utilized to pull the meta data for a single survey utlizing its survey id.

This endpoint can be utilized to create a survey. This will only create the base survey structure and default settings.

This method will generate a survey with the following:

Default survey settings applied
Hidden item page (with no items)
1 survey page (with no items)
Completion events page (with a Message item with default text)

To add items to a survey please utilize the /surveys/{{surveyId}}/items endpoints.

This endpoint can be utilized to edit a surveys meta data and basic settings.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Description	Data Type
name	Yes	Survey Name	string
description	No	Descriptive text for the survey	string
status	Yes	See status list below with possible values	enum
allow_edit_while_active	No	Allow the survey to be edited while it is public	bool (default true)
custom_url	No	Custom URL for the survey	string
is_anonymized	No	Anonymizes the responses to the survey so that no user or identifiable meta data is saved. This will not anonymize the actual response data someone submits via a question	bool
google_analytics_tracking_id	No	Google analytics tracking id that can be used to track google analytics for your survey	string
security_type	No	See chart below	enum
survey_password	No	Password required to take the survey. Only used if security_type set to PasswordProtected	string

Possible \"status\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Name	Meaning
Draft	Survey is in edit mode and not available for responses
Published	Survey is live / active and can be completed by respondents
Archived	Survey is archived, cannot be completed by respondents and is filtered in the UI

Possible \"security_type\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Type	Meaning
Public	Survey can be completed by anyone with a link to the survey with no restrictions
PasswordProtected	Respondent must posses the password to the survey. When using this you should populate the \"survey_password\" field as well
AccessControlList	Survey is restricted to contacts and users on the access list with \"Take Survey\" permission
AllRegisteredUsers	Survey can be completed by anyone that is a registered contact or user in Checkbox
InvitationOnly	Survey can only be completed using a Checkbox generated invitation link

** Editing a survey with a security tpe of Public, PasswordProtected, or Invitation Only will automatically update the default policy for the survey to include the \"Take Survey\" permission.

This endpoint can be utilized to move a survey into a specific folder. To do this you must have access to both the folder the survey is currently in and the target folder.

Status code 204 will be returned if the move was successful.

This endpoint will allow you to delete a survey. This will delete all response data, items, and survey data. This method will not ask for confirmation. To hide a survey from the UI and maintain its data please utilize the archive functionality.

This endpoint can be utilized to copy a survey. To do this you must have access to the survey.

Optional; Folder ID to place the copied survey into.

\n","type":"text/plain"},"key":"folder_id","value":"{int}"},{"description":{"content":"

Optional; Name of the copied survey

\n","type":"text/plain"},"key":"name","value":"{string}"}],"variable":[]}},"response":[],"_postman_id":"b010c6d2-374c-41cd-b48d-351238493f1f"}],"id":"0db8a974-04d8-4f29-9169-fed61f9c446c","_postman_id":"0db8a974-04d8-4f29-9169-fed61f9c446c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey Settings","item":[{"name":"Get Respondent Settings","id":"7a96e6e3-5681-4aca-87b1-9501b1427e61","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1694/respondent-settings","description":"

This endpoint can be used to modify the respondent settings for your survey. The list of respondent settings is below :

Allow Survey Back Button\nAllow Response Reset Button\nAllow Respondents to Edit Submitted Responses\nAllow REspondents to Save & Exit\nDisplay Save & Exit Button\nAnonymize Survey

This endpoint can be used to modify the respondent settings for your survey. The list of respondent settings is below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Setting Names	Meaning
allow_back_button	Allow Survey Back Button
allow_response_reset	Allow Response Reset Button
allow_complete_response_edit	Allow Respondents to Edit Submitted Responses
allow_response_resume	Allow Respondents to Save & Exit
allow_response_save	Display Save & Exit Button
anonymized	Mark responses as anonymous

This endpoint can be used to modify the response limit settings for your survey. The list of response limit settings is below :

ActivationStartDate\nActivationEndDate\nTotalResponseLimit\nPerRespondentResponseLimit

This endpoint can be used to modify the response limit settings for your survey. The list of response limit settings is below :

ActivationStartDate
ActivationEndDate
TotalResponseLimit
PerRespondentResponseLimit

This endpoint can be used to modify the appearance settings for your survey. The list of appearance settings is below :

\"show_survey_title\": false,\n\"show_page_numbers\": false,\n\"show_item_numbers\": false,\n\"enable_dynamic_page_numbers\": false,\n\"enable_dynamic_item_numbers\": false,\n\"is_item_order_randomized\": false,\n\"show_validation_error_alert\": false,\n\"show_asterisks\": false,\n\"show_progress_bar\": false,\n\"progress_bar_orientation\": null,\n\"show_compliance_link\": false\n

This endpoint can be used to modify the behavior settings for your survey. The list of behavior settings is below :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Setting Names	Meaning
show_survey_title	Displays survey title in the survey
show_page_numbers	Displays the page number the respondent is currently on
show_item_numbers	Displays an item number next to each item
enable_dynamic_page_numbers	Updates the page numbers based on conditions and branching. This will only adjust when a page that is conditionally hidden is passed.
is_item_order_randomized	Randomly orders the items in the survey. Item order is randomized when the response starts.
show_validation_error_alert	Displays a javascript alert when a required item is not answered
show_asterisks	Displays a red asterisk next to required items question text
show_progress_bar	Display a progress bar for the survey displaying the current place in the survey
progress_bar_orientation	Display Save & Exit Button
show_compliance_link	Displays a link to GDPR compliance page

This endpoint can be used to retrieve the language settings for your survey.

This endpoint can be utilized to the language settings for a survey. This includes modifying the default language for the survey, adding additional language options, and setting up how the respondent will select the language.

Possible \"language_source\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Source Name	Meaning
Prompt	Display a drop down for the respondent to select their language
QueryString	Provided in the query string of the survey
User	Read user profile property value
Browser	Read language code from the browser

The list of languages that are possible for support_languages varies based on your installation. For Checkbox Hosted the current list is below:

[[Language list coming soon]]

Survey settings are divided into several sections:

Meta Data Settings\nBehavior Settings\nAppearance Settings\nLanguage Settings

You can control most aspects of your survey through these settings. To alter meta data settings please utilize the /surveys/{{surveyId}} endpoint above. Behvaior, Appearance, and Language settings are outlined below.

\n","event":[{"listen":"prerequest","script":{"id":"c359a37c-427e-43f1-8cb6-7ee7784183a5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ca7791fe-1699-421a-9f6e-cdf615d5c468","type":"text/javascript","exec":[""]}}],"_postman_id":"5e9489ee-535a-4c26-8f35-a956e511a037","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Advanced Features","item":[{"name":"Get Survey Wide Javascript","id":"a7bad2c6-44be-44d8-9914-d4d0e759e377","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1022/survey-wide-javascript","description":"

This will return the current value of the survey wide javascript field of your survey. The data returned will have all quotes escaled and new lines will be replaced with the \\n.

This endpoint will allow you to update the survey wide javascript feature. You will need to ensure that the data is properly formatted. New lines should be entered as \\n characters and all double quotes should be escaped.

It is strongly recommended that you utilize the UI to modify javascript for your survey.

This endpoint will retrieve the current custom CSS applied to the survey using the survey-wide-css feature in the survey settings.

This endpoint will allow you to edit the survey wide CSS. The data will need to be properly escaped and formattted. It is strongly recommended that you edit custom CSS in the UI not the API.

This endpoint will retrieve the current third party references that have been added to your survey.

This endpoint will update the current third party references for your survey. The data will need to be properly escaped and formatted. It is strongly recommended that you edit third party references using the UI and not the API.

Advanced features of a survey include custom survey wide javascript, survey wide CSS, and third party references. These settings will only apply if you have these features enabled in the system settings.

\n","event":[{"listen":"prerequest","script":{"id":"922abd75-f602-4056-8e51-e894d64cc8c6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7db43075-700f-4a1a-ba6d-5b4c6fab1afe","type":"text/javascript","exec":[""]}}],"_postman_id":"a66af591-e5b6-4f14-8b04-487869836291","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey ACL ","item":[{"name":"Get Survey ACL","id":"90e55e91-de4e-4b87-9af8-ec7ab120827c","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1539/acl/","description":"

This endpoint can be utilized to pull the full access list for a survey. This will only retrieve data if you have access to the survey.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Take	Ability to complete a survey response
AnalyzeData	Ability to create and manage reports that contain this survey as a source
Administer	Manage survey settings and edit the survey. This will automatically apply Edit and Take permissions
Edit	Ability to edit the surveys items and add new items and pages
View Responses	Ability to view individual survey response data

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will return data for a single ACL entry for the survey. Both the surveyId and the entryId are required for this to return valid data.

This endpoint can be utilized to pull the full access list for a survey. This will only retrieve data if you have access to the survey.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Take	Ability to complete a survey response
AnalyzeData	Ability to create and manage reports that contain this survey as a source
Administer	Manage survey settings and edit the survey. This will automatically apply Edit and Take permissions
Edit	Ability to edit the surveys items and add new items and pages
View Responses	Ability to view individual survey response data

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to add an ACL entry to a survey. This will only grant access if the user is in a role capable of the permissions applied.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Take	Ability to complete a survey response
AnalyzeData	Ability to create and manage reports that contain this survey as a source
Administer	Manage survey settings and edit the survey. This will automatically apply Edit and Take permissions
Edit	Ability to edit the surveys items and add new items and pages
View Responses	Ability to view individual survey response data

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to edit an ACL entry for a survey. This will overwrite the existing ACL entry with the new permissions supplied on the request.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Take	Ability to complete a survey response
AnalyzeData	Ability to create and manage reports that contain this survey as a source
Administer	Manage survey settings and edit the survey. This will automatically apply Edit and Take permissions
Edit	Ability to edit the surveys items and add new items and pages
View Responses	Ability to view individual survey response data

Possible \"grantee_type\" values for this method are :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

grantee_type	Meaning
Contact	Individual contact
ContactGroup	Checkbox contact group
ContactGroupAD	Active Direcotry group (On-Premise Enterprise customers only)
PseudoContactGroup	\"Everyone\" \"ContactList\" this refers to the permissions that every contact / user has over this group

This endpoint will allow you to delete an ACL entry for a survey. This will only work if the entry exists for the survey and you have \"Edit\" access to the survey.

Deleting a ACL entry will not prompt for a verification and cannot be undone.

This endpoint can be utilized to retrieve the defualt access policy for the survey requested. These are the permissions that are applied to any user / contact not explicitly on the access control list.

This endpoint can be utilized to edit the default policy access list for a survey. These permissions will be applied to any contact not explicitly on the access list.

Possible \"Permission\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission Name	Access Granted
Take	Ability to complete a survey response
AnalyzeData	Ability to create and manage reports that contain this survey as a source
Administer	Manage survey settings and edit the survey. This will automatically apply Edit and Take permissions
Edit	Ability to edit the surveys items and add new items and pages
View Responses	Ability to view individual survey response data

This endpoint will retrieve the list of pages with their branching and condition logic for a specific survey. You will need edit access for this to return valid data. This will not return item data.

Branching and conditional logic is described in more detail in its own section which can be found on the left navigation pane.

Checkbox has 3 different page types outlined below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

page_type	Meaning
HiddenItems	Page to store hidden items. Items populated with pre-survey data such as query strings and session variables
ContentPage	Page to store question and display items. These are the main content pages for your survey where your answerable items are created
Completion	Page to store action items (such as email alerts / responses) and where your thank you message should go

This endpoint will retrieve a single page in a survey with its branching and conditional logic. This will also return its page type.

Checkbox has 3 different page types outlined below:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

page_type	Meaning
HiddenItems	Page to store hidden items. Items populated with pre-survey data such as query strings and session variables
ContentPage	Page to store question and display items. These are the main content pages for your survey where your answerable items are created
Completion	Page to store action items (such as email alerts / responses) and where your thank you message should go

An example response for a page with more complex branching and condition logic can be viewed by clicking on the request dropdown on the right side.

This endpoint can be utilized to add pages to your survey. Your page must contain a position higher then 1 and lower then the completion page. You can only add ContentPage pages to a survey. HiddenItem and Completion pages are added automatically when a survey is created.

A basic example is shown on the right side. A more complex example with conditional logic can be found by clicking on the drop down above the sample request.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","surveys","1539","pages"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"c077e3b2-0d7e-410e-8b6f-0db46987be30","name":"Add Survey Page","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"title\": \"My second page with the API\",\n \"position\": 8,\n \"page_type\": \"ContentPage\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n },\n \"branching_rules\": []\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/pages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"201","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 18:59:34 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"id\":3123,\"survey_id\":1539,\"title\":\"My second page with the API\",\"position\":8,\"page_type\":\"ContentPage\",\"include_condition\":{\"expressions\":[],\"groups\":[],\"logical_operator\":\"OR\"},\"branching_rules\":[]}"},{"id":"f266aa71-e3e9-4849-943f-2d1d4413185a","name":"Add Survey Page with Conditions","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{ \r\n \"title\":\"My second page with the API\",\r\n \"position\":8,\r\n \"page_type\":\"ContentPage\",\r\n \"include_condition\":{ \r\n \"expressions\":[ \r\n\r\n ],\r\n \"groups\":[ \r\n { \r\n \"expressions\":[ \r\n { \r\n \"left_operand\":{ \r\n \"item_id\":12561,\r\n \"operand_type\":\"SurveyItem\"\r\n },\r\n \"right_operand\":{ \r\n \"value\":\"Checkbox\",\r\n \"operand_type\":\"String\"\r\n },\r\n \"operator\":\"Equal\"\r\n }\r\n ],\r\n \"logical_operator\":\"AND\"\r\n }\r\n ],\r\n \"logical_operator\":\"OR\"\r\n },\r\n \"branching_rules\":[ \r\n\r\n ]\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/pages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"406","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:01:56 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"id\":3124,\"survey_id\":1539,\"title\":\"My second page with the API\",\"position\":9,\"page_type\":\"ContentPage\",\"include_condition\":{\"expressions\":[],\"groups\":[{\"id\":6434,\"expressions\":[{\"id\":6435,\"left_operand\":{\"item_id\":12561,\"operand_type\":\"SurveyItem\"},\"right_operand\":{\"value\":\"Checkbox\",\"operand_type\":\"String\"},\"operator\":\"Equal\"}],\"logical_operator\":\"AND\"}],\"logical_operator\":\"OR\"},\"branching_rules\":[]}"}],"_postman_id":"482e1afe-7a57-4f9c-8175-77774e9e4234"},{"name":"Edit Survey Page","id":"cdee137e-ee05-4f8a-abbd-ea8dea891ab2","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My second page with the API\",\n \"position\": 8,\n \"page_type\": \"ContentPage\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n },\n \"branching_rules\": []\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1539/pages/3123","description":"

This endpoint can be utilized to edit pages in your survey. Your page must contain a position higher then 1 and lower then the completion page. You can only modify pages with type ContentPage. You can add items to all pages using the items endpoints outlined further down the page.

A basic example is shown on the right side. A more complex example with conditional logic can be found by clicking on the drop down above the sample request.

Note that this will replace the existing page data with the new data sent in the request. If your page has condition and branching logic and you submit your request without that logic, the existing conditions and branches will be lost.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","surveys","1539","pages","3123"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"5f24665d-8750-42bb-824d-417d79fdce57","name":"Edit Survey Page","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"title\": \"My second page with the API\",\n \"position\": 8,\n \"page_type\": \"ContentPage\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n },\n \"branching_rules\": []\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/pages/{{pageId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"201","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:08:46 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"id\":3123,\"survey_id\":1539,\"title\":\"My second page with the API\",\"position\":8,\"page_type\":\"ContentPage\",\"include_condition\":{\"expressions\":[],\"groups\":[],\"logical_operator\":\"OR\"},\"branching_rules\":[]}"},{"id":"ab637e63-d7fe-4664-af81-7f44e8431de4","name":"Edit Survey Page with Conditions","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{ \r\n \"title\":\"My second page with the API\",\r\n \"position\":8,\r\n \"page_type\":\"ContentPage\",\r\n \"include_condition\":{ \r\n \"expressions\":[ \r\n\r\n ],\r\n \"groups\":[ \r\n { \r\n \"expressions\":[ \r\n { \r\n \"left_operand\":{ \r\n \"item_id\":12561,\r\n \"operand_type\":\"SurveyItem\"\r\n },\r\n \"right_operand\":{ \r\n \"value\":\"Checkbox\",\r\n \"operand_type\":\"String\"\r\n },\r\n \"operator\":\"Equal\"\r\n }\r\n ],\r\n \"logical_operator\":\"AND\"\r\n }\r\n ],\r\n \"logical_operator\":\"OR\"\r\n },\r\n \"branching_rules\":[ \r\n\r\n ]\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/pages/{{pageId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"406","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:09:26 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"id\":3123,\"survey_id\":1539,\"title\":\"My second page with the API\",\"position\":8,\"page_type\":\"ContentPage\",\"include_condition\":{\"expressions\":[],\"groups\":[{\"id\":6436,\"expressions\":[{\"id\":6437,\"left_operand\":{\"item_id\":12561,\"operand_type\":\"SurveyItem\"},\"right_operand\":{\"value\":\"Checkbox\",\"operand_type\":\"String\"},\"operator\":\"Equal\"}],\"logical_operator\":\"AND\"}],\"logical_operator\":\"OR\"},\"branching_rules\":[]}"}],"_postman_id":"cdee137e-ee05-4f8a-abbd-ea8dea891ab2"},{"name":"Edit Survey Page Position","id":"d01be435-2d22-4336-8a83-3e3ea23c338a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{surveyId}/pages/{pageId}/position?position={int}","description":"

This endpoint can be utilized to move survey page. You can only move pages with type ContentPage.

Response: If successful this will return a 204 no content response.

New survey page position.

\n","type":"text/plain"},"key":"position","value":"{int}"}],"variable":[]}},"response":[],"_postman_id":"d01be435-2d22-4336-8a83-3e3ea23c338a"},{"name":"Delete Survey Page","id":"13cb5f2e-4fe6-4a7d-9129-fe614df4c4bb","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1539/pages/3076","description":"

This endpoint will allow you to delete a page. This will delete all items, and hard delete responses for those items as well as any conditional and branching logic for this page. This action will not request a confirmation and cannot be undone. You should not utilize this method unless you are absolutely sure you want to delete the page.

This endpoint can be utilized to pull the list of items that exist on a page. The response from this method will change depending on the types of items in the page. If you are parsing this data automatically please make sure you are taking into account the different item formats. The item type is returned in the item_type property of the response.

Current possible values for \"item_type\" are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

SingleLineText	MultiLineText	DropdownList	RadioButtons	Checkboxes
Rating	RadioButtonScale	Slider	NetPromoterScale	RankOrder
MaxDiff	Signature	FileUpload	Captcha	Message
Image	Matrix	MatrixQuestionColumnElement	MatrixSumTotal	Redirect
Email	EmailResponse	Javascript	ProfileUpdater	DisplayAnalysis
DisplayResponse	HiddenItem

Samples for each item type can be found in the get survey item method below.

Test Radio button item

\",\"subtext\":\"\",\"is_required\":false,\"item_position\":\"Left\",\"question_text_position\":\"Top\",\"id\":12562,\"item_type\":\"RadioButtons\",\"page_id\":3113,\"position\":1,\"alias\":null,\"html_class\":null,\"include_condition\":{\"expressions\":[],\"groups\":[],\"logical_operator\":\"OR\"}},{\"default_text\":\"\",\"answer_format\":\"Unknown\",\"custom_format_reg_exp\":null,\"max_length\":null,\"min_value\":null,\"max_value\":null,\"autocomplete_list_id\":null,\"width\":null,\"question_text\":\"

Test single line item

\",\"subtext\":\"\",\"is_required\":false,\"item_position\":\"Left\",\"question_text_position\":\"Top\",\"id\":12563,\"item_type\":\"SingleLineText\",\"page_id\":3113,\"position\":2,\"alias\":\"\",\"html_class\":null,\"include_condition\":{\"expressions\":[],\"groups\":[],\"logical_operator\":\"OR\"}}]"}],"_postman_id":"3506447f-9e0c-43a3-ad32-46c465e148fb"},{"name":"Copy Survey Page","id":"7933fcaf-011d-41d7-8546-db41dc7ced14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{surveyId}/pages/{pageId}/copy?position={int}","description":"

This endpoint can be utilized to copy survey pages. You can only copy pages with type ContentPage.

Optional; Position of page copy in the survey, by default new page is added to the end.

Response: page copy.

\n","type":"text/plain"},"key":"position","value":"{int}"}],"variable":[]}},"response":[],"_postman_id":"7933fcaf-011d-41d7-8546-db41dc7ced14"}],"id":"22e5f440-e9cc-40cb-bb4b-2dd091089df3","_postman_id":"22e5f440-e9cc-40cb-bb4b-2dd091089df3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey Items","item":[{"name":"Get Survey Item","id":"1650efd3-60da-4891-8eb8-faa4b6e0b233","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1519/items/11440","description":"

This endpoint will return the item data for a specific item in a survey.

Different item types will return slightly different data depending on the type of item being returned. You should set up parsers for each item type in your survey if you are automating the process of retrieving item data.

The type of item is returned through the response in the \"item_type\" field. Current possible values for this field are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

SingleLineText	MultiLineText	DropdownList	RadioButtons	Checkboxes
Rating	RadioButtonScale	Slider	NetPromoterScale	RankOrder
MaxDiff	Signature	FileUpload	Captcha	Message
Image	Matrix	MatrixQuestionColumnElement	MatrixSumTotal	Redirect
Email	EmailResponse	Javascript	ProfileUpdater	DisplayAnalysis
DisplayResponse	HiddenItem	CustomSourceDropdown

Rank order question text.

\",\n \"subtext\": \"

Rank order subtext.

\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1415,\n \"item_type\": \"RankOrder\",\n \"page_id\": 1053,\n \"position\": 4,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": null,\n \"enabled\": true\n}"},{"id":"24031b91-b0d3-462c-9349-88ba9242eb55","name":"Response for Captcha Item ","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6425"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"458"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:56:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"captcha_type\": \"Visible\",\n \"size\": \"Normal\",\n \"theme\": \"Light\",\n \"question_text\": \"This is captcha item.

Enter captcha which you see on the screen\",\n \"subtext\": \"\",\n \"is_required\": true,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6425,\n \"item_type\": \"Captcha\",\n \"page_id\": 2580,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"45c3b2d4-26d9-470d-b874-d99502fb8e78","name":"Response for Rank Order Item (Selectable Drag and Drop)","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1011/items/1412"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 31 Mar 2020 13:40:35 GMT"},{"key":"Content-Length","value":"1087"}],"cookie":[],"responseTime":null,"body":"{\n \"rank_order_type\": \"SelectableDragnDrop\",\n \"option_type\": \"Text\",\n \"min_to_rank\": 1,\n \"max_to_rank\": 2,\n \"randomize\": false,\n \"choices\": [\n {\n \"id\": 1578,\n \"text\": \"Choice 1\",\n \"alias\": \"\",\n \"position\": 0,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 1,\n \"image\": null\n },\n {\n \"id\": 1579,\n \"text\": \"Choice 2\",\n \"alias\": \"\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 2,\n \"image\": null\n },\n {\n \"id\": 1580,\n \"text\": \"Choice 3\",\n \"alias\": \"\",\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 3,\n \"image\": null\n },\n {\n \"id\": 1581,\n \"text\": \"Choice 4\",\n \"alias\": \"\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 4,\n \"image\": null\n }\n ],\n \"question_text\": \"

Rank order question text.

\",\n \"subtext\": \"

Rank order subtext.

\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1412,\n \"item_type\": \"RankOrder\",\n \"page_id\": 1053,\n \"position\": 1,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": null,\n \"enabled\": true\n}"},{"id":"50392798-c625-4de3-9992-10c54ec94930","name":"Response for Matrix Item","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/items/{{itemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"4274","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:50:51 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\"rows\":[{\"id\":1214,\"position\":1,\"row_type\":\"Subheading\",\"text\":\"Answer Set 1\",\"alias\":\"Answer Set 1\",\"include_condition\":null},{\"id\":1215,\"position\":2,\"row_type\":\"Normal\",\"text\":\"In which color do you prefer to paint your wall?\",\"alias\":\"Answer\",\"include_condition\":null},{\"id\":1216,\"position\":3,\"row_type\":\"Normal\",\"text\":\"In which color do you prefer to dye your hair?\",\"alias\":\"Answer 2\",\"include_condition\":null},{\"id\":1217,\"position\":4,\"row_type\":\"Normal\",\"text\":\"Which color do you prefer in clothes?\",\"alias\":\"\",\"include_condition\":null},{\"id\":1218,\"position\":5,\"row_type\":\"Subheading\",\"text\":\"Answer Set 2\",\"alias\":\"\",\"include_condition\":null},{\"id\":1219,\"position\":6,\"row_type\":\"Normal\",\"text\":\"Which word has 5 letters?\",\"alias\":\"\",\"include_condition\":null}],\"columns\":[{\"id\":1280,\"position\":2,\"column_type\":\"Question\",\"prototype_item\":{\"layout\":\"Horizontal\",\"columns\":null,\"show_number_labels\":false,\"choices\":[{\"id\":5418,\"text\":\"Black\",\"alias\":\"\",\"position\":1,\"is_default\":false,\"is_other\":false,\"is_none_of_above\":false,\"points\":0.0000,\"image\":null},{\"id\":5419,\"text\":\"White\",\"alias\":\"3\",\"position\":2,\"is_default\":false,\"is_other\":false,\"is_none_of_above\":false,\"points\":0.0000,\"image\":null},{\"id\":5420,\"text\":\"Yellow\",\"alias\":\"4\",\"position\":3,\"is_default\":false,\"is_other\":false,\"is_none_of_above\":false,\"points\":0.0000,\"image\":null},{\"id\":5421,\"text\":\"Pink\",\"alias\":\"\",\"position\":4,\"is_default\":false,\"is_other\":false,\"is_none_of_above\":false,\"points\":0.0000,\"image\":null}],\"randomize\":false,\"allow_other\":false,\"question_text\":\"Radio\",\"subtext\":\"\",\"is_required\":false,\"item_position\":\"Left\",\"question_text_position\":\"Top\",\"id\":6453,\"item_type\":\"RadioButtons\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null},\"require_unique_answers\":false,\"width\":200},{\"id\":1445,\"position\":1,\"column_type\":\"RowTexts\",\"prototype_item\":null,\"require_unique_answers\":false,\"width\":null}],\"elements\":[{\"row\":1,\"column\":1,\"item\":{\"text\":\"Answer Set 1\",\"id\":6454,\"item_type\":\"Message\",\"alias\":\"Answer Set 1\",\"html_class\":null,\"include_condition\":null}},{\"row\":1,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6455,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}},{\"row\":2,\"column\":1,\"item\":{\"text\":\"In which color do you prefer to paint your wall?\",\"id\":6456,\"item_type\":\"Message\",\"alias\":\"Answer\",\"html_class\":null,\"include_condition\":null}},{\"row\":2,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6457,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}},{\"row\":3,\"column\":1,\"item\":{\"text\":\"In which color do you prefer to dye your hair?\",\"id\":6458,\"item_type\":\"Message\",\"alias\":\"Answer 2\",\"html_class\":null,\"include_condition\":null}},{\"row\":3,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6459,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}},{\"row\":4,\"column\":1,\"item\":{\"text\":\"Which color do you prefer in clothes?\",\"id\":6462,\"item_type\":\"Message\",\"alias\":\"\",\"html_class\":null,\"include_condition\":null}},{\"row\":4,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6463,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}},{\"row\":5,\"column\":1,\"item\":{\"text\":\"Answer Set 2\",\"id\":6460,\"item_type\":\"Message\",\"alias\":\"\",\"html_class\":null,\"include_condition\":null}},{\"row\":5,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6461,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}},{\"row\":6,\"column\":1,\"item\":{\"text\":\"Which word has 5 letters?\",\"id\":6470,\"item_type\":\"Message\",\"alias\":\"\",\"html_class\":null,\"include_condition\":null}},{\"row\":6,\"column\":2,\"item\":{\"prototype_item_type\":\"RadioButtons\",\"id\":6471,\"item_type\":\"MatrixQuestionColumnElement\",\"alias\":\"\",\"html_class\":\"\",\"include_condition\":null}}],\"grid_lines\":\"Horizontal\",\"row_text_align\":\"Center\",\"width\":500,\"question_text\":\"1. This is matrix example with radio-buttons\",\"subtext\":\"\",\"is_required\":false,\"item_position\":\"Left\",\"question_text_position\":\"Top\",\"id\":6452,\"item_type\":\"Matrix\",\"page_id\":2579,\"position\":2,\"alias\":\"\",\"html_class\":\"\",\"include_condition\":{\"expressions\":[],\"groups\":[],\"logical_operator\":\"OR\"}}"},{"id":"60772aa8-f3de-4a07-8871-1d3730bfa171","name":"Response for Hidden Item","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6486"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"269"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:59:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"question_text\": \"Test\",\n \"subtext\": null,\n \"variable_name\": \"Variable_1\",\n \"variable_source\": \"QueryString\",\n \"id\": 6486,\n \"item_type\": \"HiddenItem\",\n \"page_id\": 2566,\n \"position\": 1,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"6a8d59ad-1991-4861-aee0-ec3f318da74b","name":"Response for File Upload Item","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6423"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"433"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:56:09 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"allowed_file_types\": [\n \".jpeg\",\n \".jpg\",\n \".png\"\n ],\n \"question_text\": \"This is file upload item.

Upload your image:\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6423,\n \"item_type\": \"FileUpload\",\n \"page_id\": 2578,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"7e10e412-ec8f-4e5a-aac6-962aceca7fa9","name":"Response for Checkbox Item Type","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/items/{{itemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1419","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 11 Sep 2018 18:53:04 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":" },\r\n {\r\n \"id\":10421,\r\n \"text\":\"Other: \",\r\n \"alias\":null,\r\n \"position\":5,\r\n \"is_default\":false,\r\n \"is_other\":true,\r\n \"is_none_of_above\":false,\r\n \"points\":null,\r\n \"image\":null\r\n }\r\n ],\r\n \"randomize\":true,\r\n \"is_soft_required\":false,\r\n \"allow_other\":true,\r\n \"question_text\":\"

Please select your favorite color.

\",\r\n \"subtext\":\"\",\r\n \"is_required\":false,\r\n \"item_position\":\"Left\",\r\n \"question_text_position\":\"Top\",\r\n \"id\":11440,\r\n \"item_type\":\"Checkboxes\",\r\n \"page_id\":2932,\r\n \"position\":1,\r\n \"alias\":\"Question Alias Text\",\r\n \"html_class\":null,\r\n \"include_condition\":{\r\n \"expressions\":[\r\n \r\n ],\r\n \"groups\":[\r\n \r\n ],\r\n \"logical_operator\":\"OR\"\r\n }\r\n}"},{"id":"845b7738-4777-431b-b4dd-5bab365138b1","name":"Response for Signature Item","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/items/{{itemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"469","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:53:40 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"width\":300,\r\n \"height\":150,\r\n \"pen_color\":\"#000000\",\r\n \"question_text\":\"This is signature item.

Please, put your signature in this field\",\r\n \"subtext\":\"\",\r\n \"is_required\":false,\r\n \"is_soft_required\":false,\r\n \"item_position\":\"Left\",\r\n \"question_text_position\":\"Top\",\r\n \"id\":6432,\r\n \"item_type\":\"Signature\",\r\n \"page_id\":2585,\r\n \"position\":1,\r\n \"alias\":\"\",\r\n \"html_class\":\"\",\r\n \"include_condition\":{\r\n \"expressions\":[\r\n \r\n ],\r\n \"groups\":[\r\n \r\n ],\r\n \"logical_operator\":\"OR\"\r\n }\r\n}"},{"id":"8fc14a02-13d0-469b-bfb1-738bf706204d","name":"Response for Rank Order Item (Numeric)","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1011/items/1414"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 31 Mar 2020 13:42:59 GMT"},{"key":"Content-Length","value":"1063"}],"cookie":[],"responseTime":null,"body":"{\n \"rank_order_type\": \"Numeric\",\n \"option_type\": \"Text\",\n \"min_to_rank\": 1,\n \"max_to_rank\": 2,\n \"randomize\": false,\n \"choices\": [\n {\n \"id\": 1586,\n \"text\": \"Choice 1\",\n \"alias\": \"\",\n \"position\": 0,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 1,\n \"image\": null\n },\n {\n \"id\": 1587,\n \"text\": \"Choice 2\",\n \"alias\": \"\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 2,\n \"image\": null\n },\n {\n \"id\": 1588,\n \"text\": \"Choice 3\",\n \"alias\": \"\",\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 3,\n \"image\": null\n },\n {\n \"id\": 1589,\n \"text\": \"Choice 4\",\n \"alias\": \"\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 4,\n \"image\": null\n }\n ],\n \"question_text\": \"

Rank order question text.

\",\n \"subtext\": \"

Rank order subtext.

\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1414,\n \"item_type\": \"RankOrder\",\n \"page_id\": 1053,\n \"position\": 3,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": null,\n \"enabled\": true\n}"},{"id":"96f296ff-fde3-4db7-8b55-e475657246ae","name":"Response for Slider Item (Number Range)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6372"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"856","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:55:31 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"value_type\": \"NumberRange\",\n \"min_value\": 0,\n \"max_value\": 10,\n \"step_size\": 1,\n \"default_value\": 10,\n \"choices\": [],\n \"width\": 800,\n \"alias_position\": \"DontShow\",\n \"image_position\": \"Top\",\n \"show_value\": true,\n \"question_text\": \"This is slider item.
User is able to arrange elements (images, text, numbers) above and bottom of slider in different variations.

Are you satisfied with our service?
\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6372,\n \"item_type\": \"Slider\",\n \"page_id\": 2568,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"9cd0f63c-f6fa-4f74-9708-cddaf5a7674c","name":"Response for Custom Source Dropdown","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1010/items/1417"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 08 Apr 2020 14:33:42 GMT"},{"key":"Content-Length","value":"461"}],"cookie":[],"responseTime":null,"body":"{\n \"choice_list_url\": \"https://restcountries.eu/rest/v2/all\",\n \"value_field\": \"name\",\n \"allow_other\": false,\n \"other_text\": null,\n \"show_number_labels\": false,\n \"is_soft_required\":false,\n \"question_text\": \"

Test custom source

\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1417,\n \"item_type\": \"CustomSourceDropdown\",\n \"page_id\": 1049,\n \"position\": 4,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": null,\n \"enabled\": true\n}"},{"id":"a973b6d3-54c6-4f04-956e-7228b7dc66b8","name":"Response for Message Item","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/items/{{itemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1356","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:37:32 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"text\": \"Please take my survey!\",\n \"id\": 6560,\n \"item_type\": \"Message\",\n \"page_id\": 2579,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"b28f55f0-7b1f-4ffa-8b84-c79672a7dae3","name":"Response for Slider Item (Image)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6374"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1505","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:56:58 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"value_type\": \"Image\",\n \"min_value\": 0,\n \"max_value\": 100,\n \"step_size\": 1,\n \"default_value\": null,\n \"choices\": [\n {\n \"id\": 5209,\n \"text\": \"\",\n \"alias\": \"Happy\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": {\n \"id\": \"661F121C-A121-4A01-94FD-6F05B17D34B2\",\n \"content_id\": 1170,\n \"file_name\": \"moodt_1.png\",\n \"content_type\": \"\",\n \"content_size\": null,\n \"content_category\": \"Images\",\n \"file_url\": \"/ViewContent.aspx?contentID=1170\"\n }\n },\n {\n \"id\": 5210,\n \"text\": \"\",\n \"alias\": \"Neutral\",\n \"position\": 2,\n \"is_default\": true,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": {\n \"id\": \"D1285E70-EE14-4F5A-8378-E0D333AC3A00\",\n \"content_id\": 1171,\n \"file_name\": \"mood_3.png\",\n \"content_type\": \"\",\n \"content_size\": null,\n \"content_category\": \"Images\",\n \"file_url\": \"/ViewContent.aspx?contentID=1171\"\n }\n },\n {\n \"id\": 5211,\n \"text\": \"\",\n \"alias\": \"Unhappy\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": {\n \"id\": \"3B91E476-BDFA-457F-9050-607E4A2BD5CA\",\n \"content_id\": 1174,\n \"file_name\": \"mood_2.png\",\n \"content_type\": \"\",\n \"content_size\": null,\n \"content_category\": \"Images\",\n \"file_url\": \"/ViewContent.aspx?contentID=1174\"\n }\n }\n ],\n \"width\": null,\n \"alias_position\": \"DontShow\",\n \"image_position\": \"Top\",\n \"show_value\": true,\n \"question_text\": \"Are you satisfied with our service?\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6374,\n \"item_type\": \"Slider\",\n \"page_id\": 2568,\n \"position\": 3,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"d17c4e6c-1188-4858-9d71-a896b655519c","name":"Response for Multi-Line Text Item","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6422"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"529"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:55:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"default_text\": \"Hmmm....\",\n \"allow_html\": true,\n \"min_length\": null,\n \"max_length\": null,\n \"rows\": 20,\n \"cols\": 80,\n \"question_text\": \"This is open-ended multi-line.

What is your favorite company?\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6422,\n \"item_type\": \"MultiLineText\",\n \"page_id\": 2577,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"e2aacdf2-8cf6-4ef7-881a-459f9419255b","name":"Response for Drop Down Item","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6395"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1245"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:53:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"show_number_labels\": false,\n \"display_as_combobox\": false,\n \"choices\": [\n {\n \"id\": 5310,\n \"text\": \"USA\",\n \"alias\": \"USA\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5311,\n \"text\": \"UK\",\n \"alias\": \"UK\",\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5312,\n \"text\": \"Russia\",\n \"alias\": \"Russia\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5313,\n \"text\": \"France\",\n \"alias\": \"France\",\n \"position\": 4,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5314,\n \"text\": \"China\",\n \"alias\": \"China\",\n \"position\": 5,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n }\n ],\n \"randomize\": false,\n \"is_soft_required\":false,\n \"allow_other\": false,\n \"question_text\": \"This is Drop Down List.

In which country do you live?\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6395,\n \"item_type\": \"DropdownList\",\n \"page_id\": 2572,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"eb8fd08b-643f-451c-900e-00727644fc40","name":"Response for Slider Item (Text)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6373"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1089","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 13 Sep 2018 19:56:08 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"Microsoft-IIS/10.0","name":"Server","description":"A name for the server"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000","name":"X-Correlation-Id","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"{\n \"value_type\": \"Text\",\n \"min_value\": 0,\n \"max_value\": 100,\n \"step_size\": 1,\n \"default_value\": null,\n \"choices\": [\n {\n \"id\": 5212,\n \"text\": \"Happy\",\n \"alias\": \"Happy\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5215,\n \"text\": \"Satisfied\",\n \"alias\": \"Satisfied\",\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5213,\n \"text\": \"Neutral\",\n \"alias\": \"Neutral\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n },\n {\n \"id\": 5214,\n \"text\": \"Unhappy\",\n \"alias\": \"Unhappy\",\n \"position\": 4,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 0,\n \"image\": null\n }\n ],\n \"width\": null,\n \"alias_position\": \"DontShow\",\n \"image_position\": \"Top\",\n \"show_value\": true,\n \"question_text\": \"Are you satisfied with our service?\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6373,\n \"item_type\": \"Slider\",\n \"page_id\": 2568,\n \"position\": 2,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"f09ab4a5-c012-4a32-a9c7-c1213c3fe9b6","name":"Response for Single Line Text Item","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1409/items/6420"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"587"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 13:54:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"default_text\": \"\",\n \"answer_format\": \"Email\",\n \"custom_format_reg_exp\": \"\",\n \"max_length\": null,\n \"min_value\": null,\n \"max_value\": null,\n \"autocomplete_list_id\": null,\n \"width\": null,\n \"question_text\": \"This is open-ended single line item.

Enter your email address:\",\n \"subtext\": \"\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 6420,\n \"item_type\": \"SingleLineText\",\n \"page_id\": 2576,\n \"position\": 1,\n \"alias\": \"\",\n \"html_class\": \"\",\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"},{"id":"f4f10b70-2332-4967-8204-ea07db8975eb","name":"Response for Rank Order Item (Drag and Drop)","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1011/items/1413"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 31 Mar 2020 13:42:23 GMT"},{"key":"Content-Length","value":"1076"}],"cookie":[],"responseTime":null,"body":"{\n \"rank_order_type\": \"DragnDroppable\",\n \"option_type\": \"Text\",\n \"min_to_rank\": null,\n \"max_to_rank\": null,\n \"randomize\": false,\n \"choices\": [\n {\n \"id\": 1582,\n \"text\": \"Choice 1\",\n \"alias\": \"\",\n \"position\": 0,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 1,\n \"image\": null\n },\n {\n \"id\": 1583,\n \"text\": \"Choice 2\",\n \"alias\": \"\",\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 2,\n \"image\": null\n },\n {\n \"id\": 1584,\n \"text\": \"Choice 3\",\n \"alias\": \"\",\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 3,\n \"image\": null\n },\n {\n \"id\": 1585,\n \"text\": \"Choice 4\",\n \"alias\": \"\",\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": 4,\n \"image\": null\n }\n ],\n \"question_text\": \"

Rank order question text.

\",\n \"subtext\": \"

Rank order subtext.

\",\n \"is_required\": false,\n \"is_soft_required\":false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1413,\n \"item_type\": \"RankOrder\",\n \"page_id\": 1053,\n \"position\": 2,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": null,\n \"enabled\": true\n}"}],"_postman_id":"1650efd3-60da-4891-8eb8-faa4b6e0b233"},{"name":"Add Survey Item","id":"d453f427-8dc1-468d-81f5-d7f18ba2a84f","request":{"method":"POST","header":[{"key":"conten","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"page_id\":2931,\r\n \"item_type\":\"HiddenItem\",\r\n \"alias\":\"Hidden Item Alias\",\r\n \"question_text\":\"Test Hidden Item\",\r\n \"variable_name\":\"Variable_Name\",\r\n \"variable_source\":\"QueryString\"\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1519/items","description":"

This endpoint can be utilized to add new items to a survey. This requires a valid item JSON, which you can retrieve from the GET method documentation above and alter to match your item configuration. The same request is for adding a hidden item to page 2931 (the hidden item page of survey 1519)

Test

\",\r\n \"subtext\":\"

Test

This endpoint can be utilized to edit an existing item in a survey. This requires valid item JSON to work properly. It is suggested that you do a get on the method to retrieve its valid JSON and then use PUT to edit the item.

It is very important that when modifying an item with response options (checkbox, radio button, drop down etc) that if the option has an ID you pass that ID back in with the option. If you do not do this you will be removing the option from the list. Failing to pass the ID with the option will delete the option from Checkbox, including all answers for that option. You can add new options by adding them without the ID parameter, see \"D\" option example on the right.

Test

\",\r\n \"subtext\":\"

Test

\",\r\n \"is_required\":false,\r\n \"item_position\":\"Left\",\r\n \"question_text_position\":\"Top\",\r\n \"id\":13309,\r\n \"item_type\":\"RadioButtons\",\r\n \"page_id\":2932,\r\n \"position\":1,\r\n \"alias\":null,\r\n \"html_class\":null,\r\n \"include_condition\":{ \r\n \"groups\":[ \r\n\r\n ],\r\n \"logical_operator\":\"OR\"\r\n },\r\n \"other_value\":\"Other: Test\",\r\n \"surveyId\":\"1519\"\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/items/{{itemId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1110"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 16 Oct 2018 14:12:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"layout\": \"Vertical\",\n \"columns\": null,\n \"show_number_labels\": true,\n \"choices\": [\n {\n \"id\": 11793,\n \"text\": \"a\",\n \"alias\": null,\n \"position\": 0,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 11794,\n \"text\": \"b\",\n \"alias\": null,\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 11795,\n \"text\": \"c\",\n \"alias\": null,\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 11908,\n \"text\": \"d\",\n \"alias\": null,\n \"position\": 3,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 11909,\n \"text\": \"Other: Test\",\n \"alias\": null,\n \"position\": 4,\n \"is_default\": false,\n \"is_other\": true,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n }\n ],\n \"randomize\": false,\n \"allow_other\": true,\n \"question_text\": \"

Test

\",\n \"subtext\": \"

Test

\",\n \"is_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 13309,\n \"item_type\": \"RadioButtons\",\n \"page_id\": 2932,\n \"position\": 1,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [],\n \"logical_operator\": \"OR\"\n }\n}"}],"_postman_id":"30dc71ff-f866-49a8-aa45-f1a7f2090b3d"},{"name":"Edit Survey Item Position","id":"35d82b60-d48a-4e72-a14e-9e86a6736005","request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"survey_id\":1519,\r\n \"item_id\":13310,\r\n \"page_id\":2932,\r\n \"position\":2\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1519/items/13310/page-position","description":"

This endpoint can be utilized to edit the position of the survey item on the page. This will just move one item, and have the other items in the survey moved up or down depending on their location relative to the item being moved.

If successful this will return a 204 no content response.

This endpoint can be utilized to copy survey items. Items are copied within the same survey only.

Response: item copy.

Optional; Destination survey page, by default item copy is added to the page that has source survey item.

\n","type":"text/plain"},"key":"page_id","value":"{int}"},{"description":{"content":"

Optional; Position of item copy on the survey page, by default new item is added to the end of the destination survey page

\n","type":"text/plain"},"key":"position","value":"{int}"}],"variable":[]}},"response":[],"_postman_id":"33608606-b7d4-4794-90a6-642ef219d932"},{"name":"Delete Item","id":"82d6a029-c69e-4370-8fb1-beb6297e2107","request":{"method":"DELETE","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1519/items/13309","description":"

This endpoint can be utilized to delete an item from a survey. This will delete all responses for the item as well.

This action cannot be undone, will not request confirmation, and will hard delete response data.

This endpoint can be utilized to retrieve the survey text in JSON format.

This method can be utilized to pull the list of acceptable left operand values for your expression.

You will need to populate either item_id or page_id depending on if you are working with page logic or item logic. You will also need to populate the rule_type variable with the type of rule you are trying to edit / add. The acceptable options are: ItemIncludeCondition, PageBranchingRules, PageIncludeCondition

Leave empty if working with page logic

\n","type":"text/plain"},"key":"item_id","value":"{{ItemID}}"},{"description":{"content":"

Possible values: ItemIncludeCondition, PageBranchingRules, PageIncludeCondition

\n","type":"text/plain"},"key":"rule_type","value":"{{RuleType}}"},{"description":{"content":"

Leave empty if working with item logic

\n","type":"text/plain"},"key":"page_id","value":"{{PageID}}"},{"key":"language_code","value":"en-US"}],"variable":[]}},"response":[{"id":"e79aa18e-6886-4132-bf85-6fcdef211b65","name":"Get Left Operands","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{SurveyID}}/expression-builder/left-operand-source?item_id={{ItemID}}&rule_type={{RuleType}}&page_id={{PageID}}&language_code=en-US","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys","{{SurveyID}}","expression-builder","left-operand-source"],"query":[{"key":"item_id","value":"{{ItemID}}","description":"Leave empty if working with page logic"},{"key":"rule_type","value":"{{RuleType}}","description":"Possible values: ItemIncludeCondition, PageBranchingRules, PageIncludeCondition"},{"key":"page_id","value":"{{PageID}}"},{"key":"language_code","value":"en-US"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"573d6d49-da14-4638-96cb-8ae54ff22392"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 22 Jul 2021 17:45:50 GMT"},{"key":"Content-Length","value":"1706"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1924,\n \"text\": \"1.1 - Test\"\n }\n ],\n \"profile_properties\": [\n {\n \"key\": \"Address_1\",\n \"name\": \"Address_1\"\n },\n {\n \"key\": \"Address_2\",\n \"name\": \"Address_2\"\n },\n {\n \"key\": \"ApplicationLanguage\",\n \"name\": \"ApplicationLanguage\"\n },\n {\n \"key\": \"City\",\n \"name\": \"City\"\n },\n {\n \"key\": \"Country\",\n \"name\": \"Country\"\n },\n {\n \"key\": \"Custom_1\",\n \"name\": \"Custom_1\"\n },\n {\n \"key\": \"Custom_2\",\n \"name\": \"Custom_2\"\n },\n {\n \"key\": \"Custom_3\",\n \"name\": \"Custom_3\"\n },\n {\n \"key\": \"Department\",\n \"name\": \"Department\"\n },\n {\n \"key\": \"Email\",\n \"name\": \"Email\"\n },\n {\n \"key\": \"FirstName\",\n \"name\": \"FirstName\"\n },\n {\n \"key\": \"Group\",\n \"name\": \"Group\"\n },\n {\n \"key\": \"LastName\",\n \"name\": \"LastName\"\n },\n {\n \"key\": \"Location\",\n \"name\": \"Location\"\n },\n {\n \"key\": \"Organization\",\n \"name\": \"Organization\"\n },\n {\n \"key\": \"Phone_1\",\n \"name\": \"Phone_1\"\n },\n {\n \"key\": \"Phone_2\",\n \"name\": \"Phone_2\"\n },\n {\n \"key\": \"Postal_Code\",\n \"name\": \"Postal_Code\"\n },\n {\n \"key\": \"State_Region\",\n \"name\": \"State_Region\"\n },\n {\n \"key\": \"Title\",\n \"name\": \"Title\"\n },\n {\n \"key\": \"UserName\",\n \"name\": \"UserName\"\n },\n {\n \"key\": \"Website\",\n \"name\": \"Website\"\n }\n ],\n \"response_properties\": [\n {\n \"key\": \"CurrentDateROTW\",\n \"name\": \"Current Date (DD/MM/YYYY)\"\n },\n {\n \"key\": \"CurrentDateUS\",\n \"name\": \"Current Date (MM/DD/YYYY)\"\n },\n {\n \"key\": \"CurrentScore\",\n \"name\": \"Current Survey Score\"\n },\n {\n \"key\": \"Ended\",\n \"name\": \"Survey Completed Date\"\n },\n {\n \"key\": \"Invitee\",\n \"name\": \"Invitee\"\n },\n {\n \"key\": \"IP\",\n \"name\": \"IP Address\"\n },\n {\n \"key\": \"IsComplete\",\n \"name\": \"Survey Response Is Complete\"\n },\n {\n \"key\": \"Language\",\n \"name\": \"Response Language\"\n },\n {\n \"key\": \"LastEdit\",\n \"name\": \"Survey Response Last Modified\"\n },\n {\n \"key\": \"LastPageViewed\",\n \"name\": \"Last Page Viewed\"\n },\n {\n \"key\": \"NetworkUser\",\n \"name\": \"Network Login\"\n },\n {\n \"key\": \"RespondentGuid\",\n \"name\": \"Respondent GUID\"\n },\n {\n \"key\": \"ResponseGuid\",\n \"name\": \"Response GUID\"\n },\n {\n \"key\": \"ResponseID\",\n \"name\": \"Numeric Response ID\"\n },\n {\n \"key\": \"Started\",\n \"name\": \"Survey Start Date\"\n },\n {\n \"key\": \"UniqueIdentifier\",\n \"name\": \"Username\"\n }\n ]\n}"}],"_postman_id":"dc0d3b0b-6bb4-4d9d-b071-c926d41c1748"},{"name":"Get Operators","id":"15cd38af-d9fc-485f-953b-6ae7bb05c845","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{SurveyID}}/expression-builder/operators?left_operand_type={{LeftOperandType}}&left_operand_value={{LeftOperandValue}}","description":"

This method can be used to pull the acceptable operators for your expression. Not all operators are supported by all expressions. You should make sure that you utilize this method and pull the acceptable list before attempting to add an operator. Using an invalid operator could prevent your logic from functioning.

This is the type for the left operand. Supported values are SurveyItem, ProfileProperty, and ResponseProperty.

\n","type":"text/plain"},"key":"left_operand_type","value":"{{LeftOperandType}}"},{"description":{"content":"

The value of the left operand. This would be the \"key\" value returned from the Get Left Operands method.

\n","type":"text/plain"},"key":"left_operand_value","value":"{{LeftOperandValue}}"}],"variable":[]}},"response":[{"id":"5cb892c1-b37f-452b-b526-e344833b172c","name":"Get Operators","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{SurveyID}}/expression-builder/operators?left_operand_type={{LeftOperandType}}&left_operand_value={{LeftOperandValue}}","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys","{{SurveyID}}","expression-builder","operators"],"query":[{"key":"left_operand_type","value":"{{LeftOperandType}}","description":"This is the type for the left operand. Supported values are SurveyItem, ProfileProperty, and ResponseProperty."},{"key":"left_operand_value","value":"{{LeftOperandValue}}","description":"The value of the left operand. This would be the \"key\" value returned from the Get Left Operands method. "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"59eb821d-0e0e-4012-9270-befc42c14620"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 22 Jul 2021 17:56:00 GMT"},{"key":"Content-Length","value":"129"}],"cookie":[],"responseTime":null,"body":"[\n \"Equal\",\n \"NotEqual\",\n \"GreaterThan\",\n \"GreaterThanEqual\",\n \"LessThan\",\n \"LessThanEqual\",\n \"Contains\",\n \"DoesNotContain\",\n \"IsNull\",\n \"IsNotNull\"\n]"}],"_postman_id":"15cd38af-d9fc-485f-953b-6ae7bb05c845"},{"name":"Get Right Operands","id":"921042f3-6438-4487-9c22-42e7e53aa7ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{SurveyID}}/expression-builder/right-operand-source?left_operand_type={{LeftOperandType}}&left_operand_value={{LeftOperandValue}}&operator={{Operator}}&language_code=en-US","description":"

This method will allow you to receive the possible values for the right operand. If this returns a \"string\" for operand type then any string value you enter will be valid for the right operand. If it returns values such as \"choice\" then you must supply a value that is returned from this method as a right operand or the logic will not function properly.

This is the type for the left operand. Supported values are SurveyItem, ProfileProperty, and ResponseProperty.

\n","type":"text/plain"},"key":"left_operand_type","value":"{{LeftOperandType}}"},{"description":{"content":"

The value of the left operand. This would be the \"key\" value returned from the Get Left Operands method.

\n","type":"text/plain"},"key":"left_operand_value","value":"{{LeftOperandValue}}"},{"description":{"content":"

This is the operator value to be assigned to the logic. This should be an acceptable item from the Get Operators list.

\n","type":"text/plain"},"key":"operator","value":"{{Operator}}"},{"key":"language_code","value":"en-US"}],"variable":[]}},"response":[{"id":"c3b45725-f40b-4495-a04a-216f4a175f14","name":"Get Right Operands","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1041/expression-builder/right-operand-source?left_operand_type=SurveyItem&left_operand_value=1924&operator=Equal&language_code=en-US","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys","1041","expression-builder","right-operand-source"],"query":[{"key":"left_operand_type","value":"SurveyItem"},{"key":"left_operand_value","value":"1924"},{"key":"operator","value":"Equal"},{"key":"language_code","value":"en-US"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"3ab51fad-5899-42b6-96a4-2e7fd91a8561"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 22 Jul 2021 18:50:54 GMT"},{"key":"Content-Length","value":"105"}],"cookie":[],"responseTime":null,"body":"{\n \"operand_type\": \"Choice\",\n \"data_type\": \"Choices\",\n \"choices\": [\n {\n \"id\": 4858,\n \"text\": \"a\"\n },\n {\n \"id\": 4859,\n \"text\": \"b\"\n }\n ]\n}"}],"_postman_id":"921042f3-6438-4487-9c22-42e7e53aa7ca"},{"name":"Edit Item with Conditions","id":"03a93465-540d-402c-9da8-525edb81bde4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"choices\": [\r\n {\r\n \"id\": 4860,\r\n \"is_default\": false,\r\n \"text\": \"t\",\r\n \"alias\": null,\r\n \"points\": null,\r\n \"position\": 0\r\n },\r\n {\r\n \"id\": 4861,\r\n \"is_default\": false,\r\n \"text\": \"b\",\r\n \"alias\": null,\r\n \"points\": null,\r\n \"position\": 1\r\n },\r\n {\r\n \"id\": 4862,\r\n \"is_default\": false,\r\n \"text\": \"c\",\r\n \"alias\": null,\r\n \"points\": null,\r\n \"position\": 2\r\n }\r\n ],\r\n \"item_type\": \"Checkboxes\",\r\n \"alias\": null,\r\n \"html_class\": null,\r\n \"select_min_limit\": null,\r\n \"select_max_limit\": null,\r\n \"randomize\": false,\r\n \"allow_other\": false,\r\n \"other_value\": \"Other:\",\r\n \"none_value\": \"None Of The Above\",\r\n \"allow_none_of_above\": false,\r\n \"question_text_position\": \"Top\",\r\n \"item_position\": \"Left\",\r\n \"layout\": \"Vertical\",\r\n \"columns\": 1,\r\n \"show_number_labels\": false,\r\n \"is_required\": false,\r\n \"is_soft_required\": false,\r\n \"width\": null,\r\n \"page_id\": 1201,\r\n \"question_text\": \"

Test

\",\r\n \"subtext\": \"

test

This method matches the \"Edit Survey Item\" method above however with more detailed information regarding condition logic.

It is important that when you utilize this method to assign conditions that you pass in all other item data as well, or the item will be updated to not include that data. IE if you do not have choice options in the PUT request, all of your choices for the item will be removed. There is no way to retrieve those options once this is done. Be very careful using this method.

For the include_condition logic. You will need a group of expressions. Each expression has a \"Source\", the id of the source, its operator, and a question list that is associated with that expression.

The left_operand, right_operand, and operator values can be obtained from using the Get Left Operands, Get Operators, and Get Right Operands functions above.

You can view the \"Request\" information below to see how to format the data for the conditional logic.

Test

\",\r\n \"subtext\": \"

test

\",\r\n \"enabled\": true,\r\n \"include_condition\": {\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1924,\r\n \"operator\": \"Equal\",\r\n \"value\": 4859,\r\n \"questions_list\": [\r\n {\r\n \"key\": 1924,\r\n \"name\": \"1.1 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"Choice\",\r\n \"expression_choices\": [\r\n {\r\n \"id\": 4858,\r\n \"text\": \"a\"\r\n },\r\n {\r\n \"id\": 4859,\r\n \"text\": \"b\"\r\n }\r\n ],\r\n \"is_value_type_text\": false,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": true,\r\n \"left_operand\": {\r\n \"item_id\": 1924,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"choice_id\": 4859,\r\n \"operand_type\": \"Choice\",\r\n \"item_id\": 1924\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"logical_operator\": \"OR\"\r\n },\r\n \"id\": 1925,\r\n \"language\": \"en-US\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1041/items/1925"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"763be66b-df88-4868-95ba-70e123979dad"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 22 Jul 2021 18:58:07 GMT"},{"key":"Content-Length","value":"1151"}],"cookie":[],"responseTime":null,"body":"{\n \"select_min_limit\": null,\n \"select_max_limit\": null,\n \"allow_none_of_above\": false,\n \"layout\": \"Vertical\",\n \"columns\": 1,\n \"show_number_labels\": false,\n \"choices\": [\n {\n \"id\": 4860,\n \"text\": \"t\",\n \"alias\": null,\n \"position\": 0,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 4861,\n \"text\": \"b\",\n \"alias\": null,\n \"position\": 1,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n },\n {\n \"id\": 4862,\n \"text\": \"c\",\n \"alias\": null,\n \"position\": 2,\n \"is_default\": false,\n \"is_other\": false,\n \"is_none_of_above\": false,\n \"points\": null,\n \"image\": null\n }\n ],\n \"randomize\": false,\n \"allow_other\": false,\n \"question_text\": \"

Test

\",\n \"subtext\": \"

test

\",\n \"is_required\": false,\n \"is_soft_required\": false,\n \"item_position\": \"Left\",\n \"question_text_position\": \"Top\",\n \"id\": 1925,\n \"item_type\": \"Checkboxes\",\n \"page_id\": 1201,\n \"position\": 2,\n \"alias\": null,\n \"html_class\": null,\n \"include_condition\": {\n \"expressions\": [],\n \"groups\": [\n {\n \"id\": 1419,\n \"expressions\": [\n {\n \"id\": 1420,\n \"left_operand\": {\n \"item_id\": 1924,\n \"operand_type\": \"SurveyItem\"\n },\n \"right_operand\": {\n \"choice_id\": 4859,\n \"item_id\": 1924,\n \"operand_type\": \"Choice\"\n },\n \"operator\": \"Equal\"\n }\n ],\n \"logical_operator\": \"AND\"\n }\n ],\n \"logical_operator\": \"OR\"\n },\n \"enabled\": true\n}"}],"_postman_id":"03a93465-540d-402c-9da8-525edb81bde4"},{"name":"Edit Page with Branching Logic","id":"690d15fc-e4f4-4085-8ebb-e660bf9aeb26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"survey_id\": 1041,\r\n \"id\": 1201,\r\n \"title\": \"\",\r\n \"position\": 2,\r\n \"page_type\": \"ContentPage\",\r\n \"include_condition\": null,\r\n \"branching_rules\": [\r\n {\r\n \"go_to_page_id\": 1202,\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1924,\r\n \"operator\": \"Equal\",\r\n \"value\": 4858,\r\n \"questions_list\": [\r\n {\r\n \"key\": 1924,\r\n \"name\": \"1.1 - Test\"\r\n },\r\n {\r\n \"key\": 1925,\r\n \"name\": \"1.2 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"Choice\",\r\n \"expression_choices\": [\r\n {\r\n \"id\": 4858,\r\n \"text\": \"a\"\r\n },\r\n {\r\n \"id\": 4859,\r\n \"text\": \"b\"\r\n }\r\n ],\r\n \"is_value_type_text\": false,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": true,\r\n \"left_operand\": {\r\n \"item_id\": 1924,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"choice_id\": 4858,\r\n \"operand_type\": \"Choice\",\r\n \"item_id\": 1924\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"id\": 1232,\r\n \"condition\": {\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1924,\r\n \"operator\": \"Equal\",\r\n \"value\": 4858,\r\n \"questions_list\": [\r\n {\r\n \"key\": 1924,\r\n \"name\": \"1.1 - Test\"\r\n },\r\n {\r\n \"key\": 1925,\r\n \"name\": \"1.2 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"Choice\",\r\n \"expression_choices\": [\r\n {\r\n \"id\": 4858,\r\n \"text\": \"a\"\r\n },\r\n {\r\n \"id\": 4859,\r\n \"text\": \"b\"\r\n }\r\n ],\r\n \"is_value_type_text\": false,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": true,\r\n \"left_operand\": {\r\n \"item_id\": 1924,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"choice_id\": 4858,\r\n \"operand_type\": \"Choice\",\r\n \"item_id\": 1924\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"logical_operator\": \"OR\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{SurveyID}}/pages/{{PageID}}","description":"

This method matches the \"Edit Survey Page\" method above however with more detailed information regarding condition logic.

It is important that when you utilize this method to assign conditions that you pass in all other page data as well, or the page will be updated to not include that data. IE if you do not have the page title populated when you submit this request, the page title will be lost. There is no way to recover data that is lost in this way.

For the branching_rules logic. You will need a group of expressions. Each expression has a \"Source\", the id of the source, its operator, and a question list that is associated with that expression. Branching logic also requires a \"go_to_page_id\" variable to know what page to go to. This must be a page that is after the page the branching logic is added to. If the page id entered here is before the current page your survey may not work or could lose response data.

The left_operand, right_operand, and operator values can be obtained from using the Get Left Operands, Get Operators, and Get Right Operands functions above.

You can view the \"Request\" information below to see how to format the data for the conditional logic.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","surveys","{{SurveyID}}","pages","{{PageID}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8a6b9171-5c98-4349-85e0-b8376d618047","name":"Edit Page with Branching Logic","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"survey_id\": 1041,\r\n \"id\": 1201,\r\n \"title\": \"\",\r\n \"position\": 2,\r\n \"page_type\": \"ContentPage\",\r\n \"include_condition\": null,\r\n \"branching_rules\": [\r\n {\r\n \"go_to_page_id\": 1202,\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1924,\r\n \"operator\": \"Equal\",\r\n \"value\": 4858,\r\n \"questions_list\": [\r\n {\r\n \"key\": 1924,\r\n \"name\": \"1.1 - Test\"\r\n },\r\n {\r\n \"key\": 1925,\r\n \"name\": \"1.2 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"Choice\",\r\n \"expression_choices\": [\r\n {\r\n \"id\": 4858,\r\n \"text\": \"a\"\r\n },\r\n {\r\n \"id\": 4859,\r\n \"text\": \"b\"\r\n }\r\n ],\r\n \"is_value_type_text\": false,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": true,\r\n \"left_operand\": {\r\n \"item_id\": 1924,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"choice_id\": 4858,\r\n \"operand_type\": \"Choice\",\r\n \"item_id\": 1924\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"id\": 1232,\r\n \"condition\": {\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1924,\r\n \"operator\": \"Equal\",\r\n \"value\": 4858,\r\n \"questions_list\": [\r\n {\r\n \"key\": 1924,\r\n \"name\": \"1.1 - Test\"\r\n },\r\n {\r\n \"key\": 1925,\r\n \"name\": \"1.2 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"Choice\",\r\n \"expression_choices\": [\r\n {\r\n \"id\": 4858,\r\n \"text\": \"a\"\r\n },\r\n {\r\n \"id\": 4859,\r\n \"text\": \"b\"\r\n }\r\n ],\r\n \"is_value_type_text\": false,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": true,\r\n \"left_operand\": {\r\n \"item_id\": 1924,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"choice_id\": 4858,\r\n \"operand_type\": \"Choice\",\r\n \"item_id\": 1924\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"logical_operator\": \"OR\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1041/pages/1201"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"d1d1d616-5307-446b-b595-5106f5fc3d0d"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 22 Jul 2021 19:01:22 GMT"},{"key":"Content-Length","value":"440"}],"cookie":[],"responseTime":null,"body":"{\n \"survey_id\": 1041,\n \"id\": 1201,\n \"title\": \"\",\n \"position\": 2,\n \"page_type\": \"ContentPage\",\n \"include_condition\": null,\n \"branching_rules\": [\n {\n \"id\": 1232,\n \"go_to_page_id\": 1202,\n \"condition\": {\n \"expressions\": [],\n \"groups\": [\n {\n \"id\": 1423,\n \"expressions\": [\n {\n \"id\": 1424,\n \"left_operand\": {\n \"item_id\": 1924,\n \"operand_type\": \"SurveyItem\"\n },\n \"right_operand\": {\n \"choice_id\": 4858,\n \"item_id\": 1924,\n \"operand_type\": \"Choice\"\n },\n \"operator\": \"Equal\"\n }\n ],\n \"logical_operator\": \"AND\"\n }\n ],\n \"logical_operator\": \"OR\"\n }\n }\n ]\n}"}],"_postman_id":"690d15fc-e4f4-4085-8ebb-e660bf9aeb26"},{"name":"Edit Page With Conditions","id":"54bada00-ab99-43e1-b0e4-f2316a44d222","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"survey_id\": 1041,\r\n \"id\": 1201,\r\n \"title\": \"\",\r\n \"position\": 2,\r\n \"page_type\": \"ContentPage\",\r\n \"include_condition\": {\r\n \"groups\": [\r\n {\r\n \"expressions\": [\r\n {\r\n \"source\": \"SurveyItem\",\r\n \"question\": 1926,\r\n \"operator\": \"Equal\",\r\n \"value\": \"Test\",\r\n \"questions_list\": [\r\n {\r\n \"key\": 1926,\r\n \"name\": \"0.1 - Test\"\r\n }\r\n ],\r\n \"operand_type\": \"String\",\r\n \"expression_choices\": [],\r\n \"is_value_type_text\": true,\r\n \"is_value_type_date\": false,\r\n \"is_value_type_choices\": false,\r\n \"left_operand\": {\r\n \"item_id\": 1926,\r\n \"operand_type\": \"SurveyItem\"\r\n },\r\n \"right_operand\": {\r\n \"value\": \"Test\",\r\n \"operand_type\": \"String\"\r\n }\r\n }\r\n ],\r\n \"logical_operator\": \"AND\"\r\n }\r\n ],\r\n \"logical_operator\": \"OR\"\r\n },\r\n \"branching_rules\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1041/pages/1201","description":"

This method matches the \"Edit Survey Page\" method above however with more detailed information regarding condition logic.

The left_operand, right_operand, and operator values can be obtained from using the Get Left Operands, Get Operators, and Get Right Operands functions above.

You can view the \"Request\" information below to see how to format the data for the conditional logic.

The documentation in this section will explain how to edit pages and items with branching and conditional logic. This should only be done using the API by someone with a deep knowledge of JSON and how to utilize an API. If you are a beginner with APIs we strongly advise you to use the applications user interface to modify and add conditions and branching logic.

There are two types of logic that Checkbox supports, we refer to them as \"include_conditions\" and \"branching rules\". Each of these contains groups of logic, all separated by logical operators.

Each group contains a list of expressions. Each expression contains a left operand, right operand, and an operator.

Left operand is the source of the logic, what the input will be compared to.\nThe operator is the comparison logic (\"NotEqual\", \"Equal\", etc)\nRight operand is the comparison value

You can see the following methods for examples on how this is formatted in the request.

\n","_postman_id":"c8cddb12-0cd0-4f21-a069-da7530d01b43","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"6f536387-388d-485b-8370-5a80f7d65111","description":"

The surveys endpoint can be utilized to pull survey data (not response data), create, edit, delete and manage survey meta data. This endpoint can also be utilized to move a survey into a folder or archive a survey.

\n","event":[{"listen":"prerequest","script":{"id":"a994efdf-ec20-4241-aea3-efd88b06c5cd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8f8aaa34-0ef6-4a63-8643-b8bc69241247","type":"text/javascript","exec":[""]}}],"_postman_id":"6f536387-388d-485b-8370-5a80f7d65111","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Responses","item":[{"name":"Export to CSV","id":"4ad4b40a-e345-47cb-9afd-ed1ac2ec14fa","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1651/export-responses/csv?include_test_responses=true&include_open_ended_results=true&include_hidden_items=true&include_partial_responses=true&include_detailed_response_info=true&include_detailed_contact_info=true&include_detailed_score_info=true&include_possible_score=true&strip_html_tags=true&export_rank_order_points=true&export_with_aliases=true&start_date=2018-11-18&end_date=2018-12-18&merge_select_multiple_results=true","description":"

This endpoint can be utilized to retrieve a CSV file with the response data for the survey. This will return the same file that can be retrieved from the user interface.

You can then parse this file or distribute it outside of Checkbox.

true/false - Specifies whether to include responses that have been labeled as test responses using the Checkbox UI

\n","type":"text/plain"},"key":"include_test_responses","value":"true"},{"description":{"content":"

true/false - Specifies whether to include open ended questions in the export.

\n","type":"text/plain"},"key":"include_open_ended_results","value":"true"},{"description":{"content":"

true/false - Specifies whether to include values for \"hidden\" item types

\n","type":"text/plain"},"key":"include_hidden_items","value":"true"},{"description":{"content":"

true/false - Specifies whether to include responses that haven't been completed.

\n","type":"text/plain"},"key":"include_partial_responses","value":"true"},{"key":"include_detailed_response_info","value":"true"},{"key":"include_detailed_contact_info","value":"true"},{"key":"include_detailed_score_info","value":"true"},{"key":"include_possible_score","value":"true"},{"key":"strip_html_tags","value":"true"},{"key":"export_rank_order_points","value":"true"},{"key":"export_with_aliases","value":"true"},{"description":{"content":"

(Optional) Start date to filter exported responses using the date of the response.

\n","type":"text/plain"},"key":"start_date","value":"2018-11-18"},{"description":{"content":"

(Optional) End date to filter exported responses using the date of the response.

\n","type":"text/plain"},"key":"end_date","value":"2018-12-18"},{"key":"merge_select_multiple_results","value":"true"},{"disabled":true,"key":"","value":"true"}],"variable":[]}},"response":[{"id":"c4f26ef5-6698-49e9-b13e-ab3f9157221c","name":"Export to CSV","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1651/export-responses/csv?include_test_responses=true&include_open_ended_results=true&include_hidden_items=true&include_partial_responses=true&include_detailed_response_info=true&include_detailed_contact_info=true&include_detailed_score_info=true&strip_html_tags=true&export_rank_order_points=true&export_with_aliases=true","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys","1651","export-responses","csv"],"query":[{"key":"include_test_responses","value":"true"},{"key":"include_open_ended_results","value":"true"},{"key":"include_hidden_items","value":"true"},{"key":"include_partial_responses","value":"true"},{"key":"include_detailed_response_info","value":"true"},{"key":"include_detailed_contact_info","value":"true"},{"key":"include_detailed_score_info","value":"true"},{"key":"strip_html_tags","value":"true"},{"key":"export_rank_order_points","value":"true"},{"key":"export_with_aliases","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/csv"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"Content-Disposition","value":"attachment; filename=\"Export CSV Test Survey-responses-2018-12-21.csv\""},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 21 Dec 2018 14:22:49 GMT"}],"cookie":[],"responseTime":null,"body":"\"ResponseID\",\"Score\",\"

Radio button item

\",\"

Checkbox Item

_Option 1 \",\"

Checkbox Item

_Option 2\",\"

Checkbox Item

_Option 3\"\r\n\"408256\",\"0\",\"Option 1\",\"0\",\"1\",\"0\"\r\n\"408257\",\"0\",\"Option 3\",\"0\",\"1\",\"0\"\r\n\"408258\",\"0\",\"Option 1\",\"1\",\"0\",\"0\"\r\n"}],"_postman_id":"4ad4b40a-e345-47cb-9afd-ed1ac2ec14fa"},{"name":"Get Responses","id":"a411bc10-3887-4b42-85d7-d58243b6483a","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1651/responses?include_test=true&min_started_date=2018-11-18&respondent_id=admin&status=completed&page_num=1&page_size=25&sort_by=Started","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","surveys","1651","responses"],"host":["{{URL}}"],"query":[{"key":"include_test","value":"true"},{"key":"min_started_date","value":"2018-11-18"},{"key":"respondent_id","value":"admin"},{"key":"status","value":"completed"},{"key":"page_num","value":"1"},{"key":"page_size","value":"25"},{"key":"sort_by","value":"Started"}],"variable":[]}},"response":[{"id":"41360ecd-b7f2-4530-a673-237a1639af34","name":"Get Responses","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1651/responses?include_test=true&min_started_date=2018-11-18&respondent_id=admin&status=completed&page_num=1&page_size=25&sort_by=Started","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","surveys","1651","responses"],"query":[{"key":"include_test","value":"true"},{"key":"min_started_date","value":"2018-11-18"},{"key":"respondent_id","value":"admin"},{"key":"status","value":"completed"},{"key":"page_num","value":"1"},{"key":"page_size","value":"25"},{"key":"sort_by","value":"Started"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 21 Dec 2018 16:53:46 GMT"},{"key":"Content-Length","value":"1276"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 3,\n \"items\": [\n {\n \"id\": \"508695D7-D867-461A-8D0C-EA04EE315F2D\",\n \"numeric_id\": 408256,\n \"survey_id\": 1651,\n \"status\": \"Completed\",\n \"language\": \"en-US\",\n \"started\": \"2018-12-21T14:21:02.883\",\n \"last_edit\": \"2018-12-21T14:21:09.987\",\n \"ended\": \"2018-12-21T14:21:09.987\",\n \"ip_address\": \"127.0.0.1\",\n \"is_test\": true,\n \"contact_id\": \"admin\",\n \"anonymous_respondent_id\": null,\n \"recipient_id\": \"test@checkbox.com\",\n \"is_anonymized\": false\n },\n {\n \"id\": \"D35D1B7A-BD2B-42B5-82D7-E629F0D5FAD8\",\n \"numeric_id\": 408257,\n \"survey_id\": 1651,\n \"status\": \"Completed\",\n \"language\": \"en-US\",\n \"started\": \"2018-12-21T14:21:16.543\",\n \"last_edit\": \"2018-12-21T14:21:22.687\",\n \"ended\": \"2018-12-21T14:21:22.687\",\n \"ip_address\": \"127.0.0.1\",\n \"is_test\": true,\n \"contact_id\": \"admin\",\n \"anonymous_respondent_id\": null,\n \"recipient_id\": null,\n \"is_anonymized\": false\n },\n {\n \"id\": \"13DF2A29-6AE7-4CFF-9A07-1F574489AA42\",\n \"numeric_id\": 408258,\n \"survey_id\": 1651,\n \"status\": \"Completed\",\n \"language\": \"en-US\",\n \"started\": \"2018-12-21T14:21:30.147\",\n \"last_edit\": \"2018-12-21T14:21:39.097\",\n \"ended\": \"2018-12-21T14:21:39.097\",\n \"ip_address\": \"127.0.0.1\",\n \"is_test\": true,\n \"contact_id\": \"admin\",\n \"anonymous_respondent_id\": null,\n \"recipient_id\": null,\n \"is_anonymized\": false\n }\n ],\n \"paging_info\": {\n \"page_size\": 25,\n \"page_num\": 1\n },\n \"has_next\": false,\n \"has_previous\": false\n}"}],"_postman_id":"a411bc10-3887-4b42-85d7-d58243b6483a"},{"name":"Get Response Summary","id":"1a68ac15-028f-4533-bda5-ba961d2b5300","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1651/responses/summary","description":"

This endpoint will give a brief summary of the response counts for the survey. This will give the number of completed responses, incomplete responses, and test responses.

This endpoint will pull detailed response data for a single response.

You can utilize this endpoint to bulk-delete responses based an array of response ids.

The response will return a list of the number of deleted responses.

This endpoint can be utilized to retrieve a filtered list of the style templates available to you.

Used for searching by name

\n","type":"text/plain"},"key":"search_text","value":"{string}"},{"description":{"content":"

Used for filtering on if the style is in use or not

\n","type":"text/plain"},"key":"in_use","value":"{bool}"},{"description":{"content":"

Number of contacts per page returned

\n","type":"text/plain"},"key":"page_size","value":"{int}"},{"description":{"content":"

Page number to be returned

\n","type":"text/plain"},"key":"page_num","value":"{int}"}],"variable":[]}},"response":[{"id":"b6abc4ff-44aa-4094-a690-6bd790bbbaec","name":"Get Style Templates","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{URL}}/{{ACCOUNT_NAME}}/style-templates?search_Text=developer&in_use=false","host":["{{URL}}"],"path":["{{ACCOUNT_NAME}}","style-templates"],"query":[{"key":"search_Text","value":"developer","description":"Used for searching by style name"},{"key":"in_use","value":"false","description":"Filter based on if the style is currently being used"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"728"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 21:03:53 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1750,\n \"name\": \"Developer Test Style 1\",\n \"header\": \"

Header Text

\",\n \"footer\": \"

Footer Text

\",\n \"created_by\": \"admin\",\n \"created_date\": \"2018-12-13T00:01:00.787\",\n \"is_public\": true,\n \"is_editable\": true,\n \"modified_date\": \"2018-12-13T00:03:51.19\",\n \"modified_by\": \"admin\",\n \"custom_css\": \"body{\\n color:red;\\n}\",\n \"main_font\": \"Arial, HelveticaNeue\",\n \"main_font_size\": \"18px\",\n \"main_font_color\": \"#751ca4\",\n \"header_color\": \"#2567c2\",\n \"header_image\": null,\n \"header_image_repeat\": false,\n \"footer_color\": \"#8be2ed\",\n \"footer_image\": null,\n \"footer_image_repeat\": false,\n \"background_color\": \"#d0b75d\",\n \"background_image\": null,\n \"background_image_repeat\": false,\n \"button_color\": \"#2567c2\",\n \"button_text_color\": \"#ffb49c\",\n \"show_progress_bar\": true,\n \"is_header_above\": false\n }\n]"}],"_postman_id":"01251193-bb5f-4133-ac0c-1b63ca16e57f"},{"name":"Get Style Template","id":"742178ca-3d28-45a3-807c-2ed29b4d66ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/1750","description":"

This endpoint can be utilized to retrieve the data for a style template.

Header Text

\",\n \"footer\": \"

Footer Text

\",\n \"created_by\": \"admin\",\n \"created_date\": \"2018-12-13T00:01:00.787\",\n \"is_public\": true,\n \"is_editable\": true,\n \"modified_date\": \"2018-12-13T00:03:51.19\",\n \"modified_by\": \"admin\",\n \"custom_css\": \"body{\\n color:red;\\n}\",\n \"main_font\": \"Arial, HelveticaNeue\",\n \"main_font_size\": \"18px\",\n \"main_font_color\": \"#751ca4\",\n \"header_color\": \"#2567c2\",\n \"header_image\": null,\n \"header_image_repeat\": false,\n \"footer_color\": \"#8be2ed\",\n \"footer_image\": null,\n \"footer_image_repeat\": false,\n \"background_color\": \"#d0b75d\",\n \"background_image\": null,\n \"background_image_repeat\": false,\n \"button_color\": \"#2567c2\",\n \"button_text_color\": \"#ffb49c\",\n \"show_progress_bar\": true,\n \"is_header_above\": false\n}"}],"_postman_id":"742178ca-3d28-45a3-807c-2ed29b4d66ef"},{"name":"Get Style Template CSS","id":"4c9f3dde-4214-4b9b-802e-8d688de0712e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/1750/css","description":"

This endpoint can be utilized to retrieve the CSS result for the style template which is utilized by the survey.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","style-templates","1750","css"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"c0b5b386-4ed7-4977-a34b-ae42598b86ff","name":"Template CSS","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/{{styleTemplateId}}/css"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"private"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/css"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"Content-Disposition","value":"attachment; filename=styleTemplates_12130351190.css"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 21:09:30 GMT"}],"cookie":[],"responseTime":null,"body":".cb-take-survey-section {\n font-family: Arial, HelveticaNeue; /* Main Font Family */\n font-size: 18px; /* Main Font Size */\n color: #751ca4; /* Main Font Color */\n}\n\n.cb-take-survey-section.cb-style-template-survey {\n font-size: 18px; /* Main Font Size */\n background: #d0b75d; /* Background Color */\n \n /* background: url('https://placeimg.com/640/480/nature') no-repeat 50% 50%;*/\n /* background-image: none;*/\n}\n\n.cb-take-survey-section .cb-survey-header {\n background-color: #2567c2; /* Header Color */\n \n /* background: url('https://placeimg.com/640/480/nature') no-repeat 50% 50%;*/\n /* background-image: none;*/\n\n \n /* margin-bottom: 50px; */ /* + for is-header-above, - for is-header-inline */\n /* padding-bottom: 40px; */ /* + for is-header-above, - for is-header-inline */\n}\n\n .cb-take-survey-section .cb-take-survey-buttons-container {\n background-color: #8be2ed; /* Footer Color */\n \n /* background: url('https://placeimg.com/640/480/nature') no-repeat 50% 50%;*/\n /* background-image: none;*/\n }\n\n.cb-take-survey-section .cb-take-survey-buttons-container .btn-next,\n.cb-take-survey-section .cb-take-survey-buttons-container .btn-next[disabled],\n.cb-survey-progress-bar .progress-bg,\n.mat-progress-bar-fill::after,\n.cb-take-survey-section .mat-radio-button.mat-accent .mat-radio-inner-circle,\n.cb-take-survey-section .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-inner-circle,\n.cb-take-survey-section .mat-checkbox.mat-checkbox-checked.mat-accent .mat-checkbox-background,\n.cb-take-survey-section .mat-checkbox.mat-checkbox-indeterminate.mat-accent .mat-checkbox-background,\n.cb-app-content .item-card-preview .mat-radio-button.mat-accent .mat-radio-inner-circle,\n.cb-app-content .item-card-preview .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-inner-circle,\n.cb-app-content .item-card-preview.inner-item-card .mat-radio-button.mat-accent .mat-radio-inner-circle,\n.cb-app-content .item-card-preview.inner-item-card .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-inner-circle,\n.cb-app-content .item-card-preview .mat-checkbox.mat-checkbox-checked.mat-accent .mat-checkbox-background,\n.cb-app-content .item-card-preview.inner-item-card .mat-checkbox.mat-checkbox-checked.mat-accent .mat-checkbox-background {\n background-color: #2567c2; /* Button Color */\n}\n\n.cb-take-survey-section .cb-take-survey-buttons-container .btn-next,\n.cb-take-survey-section .cb-take-survey-buttons-container .btn-next[disabled] {\n color: #ffb49c; /* Button Text Color */\n}\n\n.mat-progress-bar .mat-progress-bar-buffer {\n background: transparent;\n border: 1px solid #ccc;\n box-sizing: border-box;\n}\n\n.cb-take-survey-section .cb-take-survey-progress {\n display: block; /* :block to show Progress bar, :none otherwise */\n}\n\n.mat-progress-bar .mat-progress-bar-buffer,\n.cb-take-survey-section .cb-survey-progress-bar,\n.cb-take-survey-section .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-outer-circle,\n.cb-take-survey-section .mat-radio-button.mat-accent.mat-radio-disabled .mat-radio-outer-circle,\n.cb-take-survey-section .mat-radio-button .mat-radio-outer-circle,\n.cb-take-survey-section .mat-checkbox .mat-checkbox-frame,\n.cb-app-content .item-card-preview .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-outer-circle,\n.cb-app-content .item-card-preview .mat-radio-button.mat-accent.mat-radio-disabled .mat-radio-outer-circle,\n.cb-app-content .item-card-preview .mat-radio-outer-circle,\n.cb-app-content .item-card-preview.inner-item-card .mat-radio-button.mat-accent.mat-radio-checked .mat-radio-outer-circle,\n.cb-app-content .item-card-preview.inner-item-card .mat-radio-button.mat-accent.mat-radio-disabled .mat-radio-outer-circle,\n.cb-app-content .item-card-preview.inner-item-card .mat-radio-outer-circle,\n.cb-app-content .item-card-preview .mat-checkbox .mat-checkbox-frame, .item-card-preview.inner-item-card .mat-checkbox .mat-checkbox-frame {\n border-color: #2567c2; /* Button Color */\n}\n\n.cb-take-survey-section .mat-slider.mat-accent .mat-slider-thumb,\n.cb-take-survey-section .mat-slider.mat-accent .mat-slider-thumb-label,\n.cb-take-survey-section .mat-slider.mat-accent .mat-slider-track-fill,\n.cb-app-content .item-card-preview .mat-slider.mat-accent .mat-slider-thumb,\n.cb-app-content .item-card-preview .mat-slider.mat-accent .mat-slider-thumb-label,\n.cb-app-content .item-card-preview .mat-slider.mat-accent .mat-slider-track-fill {\n background-color: #2567c2; /* Button Color */\n border-color: #2567c2; /* Button Color */\n}\n\n.cb-app-content .item-card-preview .cb-custom-slider .slider-custom-ticks-list .slider-custom-tick,\n.cb-take-survey-section .cb-custom-slider .slider-custom-ticks-list .slider-custom-tick {\n background-color: #2567c2; /* Button Color */\n}\n\n.cb-app-content .item-card-preview .rating .star-rate,\n.cb-take-survey-section .rating .star-rate {\n color: #2567c2; /* Button Color */\n}\n\nbody{\n color:red;\n}\n"}],"_postman_id":"4c9f3dde-4214-4b9b-802e-8d688de0712e"},{"name":"Copy Style Template","id":"a5b2b6ea-4552-4754-b3a6-999220b34000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/1750/copy","description":"

This endpoint will allow you to copy an existing style template into a new template. The new style will have the same name as the copied style with a number incremented at the end of the name. The new style template will be returned in the response.

Header Text

\",\n \"footer\": \"

Footer Text

\",\n \"created_by\": \"admin\",\n \"created_date\": \"2018-12-13T00:12:43.5859009+03:00\",\n \"is_public\": true,\n \"is_editable\": true,\n \"modified_date\": \"2018-12-13T00:12:43.5859009+03:00\",\n \"modified_by\": \"admin\",\n \"custom_css\": \"body{\\n color:red;\\n}\",\n \"main_font\": \"Arial, HelveticaNeue\",\n \"main_font_size\": \"18px\",\n \"main_font_color\": \"#751ca4\",\n \"header_color\": \"#2567c2\",\n \"header_image\": null,\n \"header_image_repeat\": false,\n \"footer_color\": \"#8be2ed\",\n \"footer_image\": null,\n \"footer_image_repeat\": false,\n \"background_color\": \"#d0b75d\",\n \"background_image\": null,\n \"background_image_repeat\": false,\n \"button_color\": \"#2567c2\",\n \"button_text_color\": \"#ffb49c\",\n \"show_progress_bar\": true,\n \"is_header_above\": false\n}"}],"_postman_id":"a5b2b6ea-4552-4754-b3a6-999220b34000"},{"name":"Edit Style Template","id":"2a36fd74-1ffd-472a-8b67-780f5fe83700","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Developer Test Style 3\",\n \"header\": \"

Header Text

\",\n \"footer\": \"

Footer Text

This endpoint will allow you to edit an existing style template.

Header Text

\",\n \"footer\": \"

Footer Text

\",\n \"created_by\": \"admin\",\n \"created_date\": \"2018-12-13T00:01:00.787\",\n \"is_public\": true,\n \"is_editable\": true,\n \"modified_date\": \"2018-12-13T00:03:51.19\",\n \"modified_by\": \"admin\",\n \"custom_css\": \"body{\\n color:red;\\n}\",\n \"main_font\": \"Arial, HelveticaNeue\",\n \"main_font_size\": \"18px\",\n \"main_font_color\": \"#751ca4\",\n \"header_color\": \"#2567c2\",\n \"header_image\": null,\n \"header_image_repeat\": false,\n \"footer_color\": \"#8be2ed\",\n \"footer_image\": null,\n \"footer_image_repeat\": false,\n \"background_color\": \"#d0b75d\",\n \"background_image\": null,\n \"background_image_repeat\": false,\n \"button_color\": \"#2567c2\",\n \"button_text_color\": \"#ffb49c\",\n \"show_progress_bar\": true,\n \"is_header_above\": false\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/{{styleTemplateId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"737"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 12 Dec 2018 21:22:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1750,\n \"name\": \"Developer Test Style 3\",\n \"header\": \"

Header Text

\",\n \"footer\": \"

Footer Text

\",\n \"created_by\": \"admin\",\n \"created_date\": \"2018-12-13T00:01:00.787\",\n \"is_public\": true,\n \"is_editable\": true,\n \"modified_date\": \"2018-12-13T00:22:48.7842961+03:00\",\n \"modified_by\": \"admin\",\n \"custom_css\": \"body{\\n color:red;\\n}\",\n \"main_font\": \"Arial, HelveticaNeue\",\n \"main_font_size\": \"18px\",\n \"main_font_color\": \"#751ca4\",\n \"header_color\": \"#2567c2\",\n \"header_image\": null,\n \"header_image_repeat\": false,\n \"footer_color\": \"#8be2ed\",\n \"footer_image\": null,\n \"footer_image_repeat\": false,\n \"background_color\": \"#d0b75d\",\n \"background_image\": null,\n \"background_image_repeat\": false,\n \"button_color\": \"#2567c2\",\n \"button_text_color\": \"#ffb49c\",\n \"show_progress_bar\": true,\n \"is_header_above\": false\n}"}],"_postman_id":"2a36fd74-1ffd-472a-8b67-780f5fe83700"},{"name":"Delete Style Template","id":"cb05cda7-b513-4426-82e4-a96c2331583d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/style-templates/1751","description":"

This endpoint will delete the style template passed into the method. This will not ask for a confirmation and cannot be undone. This should only be done if you are absolutely sure the style template should be removed.

This endpoint will allow you to retrieve all invitations for a specific survey.

The \"scheduled_date\" paramater will always show the closets scheduled date in the future if one exists, or the last scheduled date if one in the future does not exist.

This endpoint will allow you to retrieve data for a specific invitation for a survey.

The \"scheduled_date\" paramater will always show the closets scheduled date in the future if one exists, or the last scheduled date if one in the future does not exist.

This endpoint will allow you to create a new invitation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Description	Data Type
name	No	Invitation Name	string
allow_auto_login	no	Survey URL will automatically log the user in when clicked	bool (default true)
allow_opt_out	Yes	Requires that the invitation contain an unsubscribe merge code.	bool (default false)
company_profile_id	Yes	ID of company profile to use for this invitation	int

For Checkbox Hosted customers the setting \"allow_opt_out\" is ignored and will also be set to true regardless of user input.

This endpoint will allow you to edit an already existing invitation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Description	Data Type
name	No	Invitation Name	string
allow_auto_login	no	Survey URL will automatically log the user in when clicked	bool (default true)
allow_opt_out	Yes	Requires that the invitation contain an unsubscribe merge code.	bool (default false)
company_profile_id	Yes	ID of company profile to use for this invitation	int

For Checkbox Hosted customers the setting \"allow_opt_out\" is ignored and will also be set to true regardless of user input.

This endpoint can be utilized to copy an already existing invitation, with the recipient list, to a new invitation.

This endpoint can be utilized to delete an invitation. This will delete all data tied to the invitation but will not delete survey responses. Once deleted and invitation cannot be restored and you will no longer be able to send out reminders for the invitation.

Note - this endpoint is only available on versions 7.56 and higher.

This endpoint can be utilized to create and send a new invitation using an existing invitations message and reminder text. This allows you to send an invitation with a single API request instead of using multiple to create an invitation, add recipients, then schedule the invite.

This endpoint also allows you to both create or update contacts in Checkbox with the single request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Description	Data Type
recipient_email	yes	E-mail of the recipient you would like to send the invite to	string
source_invitation_id	yes	ID of the invitation you would like to use for invitation message and reminder text.	int
reminder_date	no	Date to send out the first reminder for this invitation. This will only send if the recipient does not respond before the date.	datetime
profile_properties	no	List of profile property fields to update or create for the recipient	array of key value pairs \"property_name\", \"value\"
create_contact_if_not_exist	Yes	This will allow you to create a contact for the recipient email if it does not exist. This allows you to utilize profile property fields and merging in your message.	bool

Note - this endpoint is only available on versions 7.56 and higher.

This endpoint can be utilized to create and send a new invitation using an existing invitation message and reminder text. The source invitation must be an SMS invitation in order to utilize this request. For e-mail invitations please use the \"Send Simple Invitation Email\" endpoint above.

This allows you to send an invitation with a single API request instead of using multiple requests to create an invitation, add recipients, and then schedule the invite.

This endpoint also allows you to both create or update contacts in Checkbox with the single request.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Required	Description	Data Type
recipient_phone_sms	yes	SMS Number of the recipient you would like to send to	string
source_invitation_id	yes	ID of the invitation you would like to use for invitation message and reminder text. This must be a SMS invitation.	int
reminder_date	no	Date to send out the first reminder for this invitation. This will only send if the recipient does not respond before the date.	datetime
profile_properties	no	List of profile property fields to update or create for the recipient	array of key value pairs \"property_name\", \"value\"
create_contact_if_not_exist	Yes	This will allow you to create a contact for the recipient phone number if it does not exist. This allows you to utilize profile property fields and merging in your message.	bool

This endpoint will allow you to retrieve the invitation message, from email, from name, and subject fields for the invitation. Invitation messages for Checkbox 7 are in HTML by default and will be sent out with a plain text version converted from the HTML version. There is no need to specify a plain text version of the email.

If you would like to opt out of future surveys, please click here.

To contact us, please write to:
@@{FooterCompany} w @@{FooterAddress1} w @@{FooterCity}, @@{FooterState} @@{FooterPostCode} w @@{FooterCountry}

\"\r\n}"}],"_postman_id":"f6badd26-169c-4891-9574-74960c1a8bb7"},{"name":"Edit Invitation Message","id":"539d5b21-6bc5-46f1-a522-baf64047447f","request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"from_email\": \"surveyadmin@yourdomain.com\",\r\n \"from_name\": \"Checkbox Survey\",\r\n \"subject\": \"Invitation to take a survey at Checkbox® 7\",\r\n \"body\": \"You have been invited to take the survey: Developer Test Survey.

Click hereto take the survey

===================================
Unsubscribe from this list

Our mailing address is:
@@{FooterCompany}
@@{FooterAddress1}
@@{FooterAddress2}
@@{FooterCity}, @@{FooterState} @@{FooterPostCode}
@@{FooterCountry}

If you would like to opt out of future surveys, please click here.

To contact us, please write to:
@@{FooterCompany} w @@{FooterAddress1} w @@{FooterCity}, @@{FooterState} @@{FooterPostCode} w @@{FooterCountry}

\"\r\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1022/invitations/1194/message","description":"

This endpoint will allow you to edit the invitation message, from email, from name, and subject fields for the invitation. Invitation messages for Checkbox 7 are in HTML by default and will be sent out with a plain text version converted from the HTML version. There is no need to specify a plain text version of the email.

The following text strings are required in the invitation message for Checkbox Hosted customers or your invitation will not be sent to recipients. These strings must be visible and cannot be hidden due to CSS.

@@{OPT_OUT_PLACEHOLDER__DO_NOT_ERASE}
@@{FooterCompany}
@@{FooterAddress1}
@@{FooterCity}
@@{FooterPostCode}
@@{FooterCountry}

The survey link is generated for each recipient automatically. This is done by replacing the text @@{SURVEY_URL_PLACEHOLDER__DO_NOT_ERASE} in your invitation with a generated link for the recipient. You should ensure that anywhere you want the URL of your survey to be in your invitation message this string is present.

If you would like to opt out of future surveys, please click here.

To contact us, please write to:
@@FooterCompany w @@FooterAddress1 w @@FooterCity, @@FooterState @@FooterPostCode w @@FooterCountry

\"\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/{{surveyId}}/invitations/{{invitationId}}/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"2016"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 18 Oct 2018 17:50:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\r\n \"from_email\": \"surveyadmin@yourdomain.com\",\r\n \"from_name\": \"Checkbox Survey\",\r\n \"subject\": \"Invitation to take a survey at Checkbox® 7\",\r\n \"body\": \"You have been invited to take the survey: Developer Test Survey.

Click hereto take the survey

===================================
Unsubscribe from this list

Our mailing address is:
@@{FooterCompany}
@@{FooterAddress1}
@@{FooterAddress2}
@@{FooterCity}, @@{FooterState} @@{FooterPostCode}
@@{FooterCountry}

This endpoint will allow you to retrieve the reminder message for the invitation. Reminder messages for Checkbox 7 are in HTML by default and will be sent out with a plain text version converted from the HTML version. There is no need to specify a plain text version of the email.

You have been invited to take the survey: 66579.

Click here to take the survey

\\n

@@FooterCompany @@FooterAddress1 @@FooterAddress2, @@FooterCity, @@FooterState @@FooterPostCode, @@FooterCountry
Unsubscribe

\\n

\"\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1038/invitations/1032/reminder","description":"

This endpoint will allow you to edit the reminder message. Reminder messages for Checkbox 7 are in HTML by default and will be sent out with a plain text version converted from the HTML version. There is no need to specify a plain text version of the email.

The following text strings are required in the reminder message for Checkbox Hosted customers or your invitation will not be sent to recipients. These strings must be visible and cannot be hidden due to CSS.

@@{OPT_OUT_PLACEHOLDER__DO_NOT_ERASE}
@@{FooterCompany}
@@{FooterAddress1}
@@{FooterCity}
@@{FooterPostCode}
@@{FooterCountry}

The survey link is generated for each recipient automatically. This is done by replacing the text @@{SURVEY_URL_PLACEHOLDER__DO_NOT_ERASE} in your reminder with a generated link for the recipient. You should ensure that anywhere you want the URL of your survey to be in your invitation message this string is present.

You have been invited to take the survey: 66579.

Click here to take the survey

\\n

@@FooterCompany @@FooterAddress1 @@FooterAddress2, @@FooterCity, @@FooterState @@FooterPostCode, @@FooterCountry
Unsubscribe

\\n

\"\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1038/invitations/1032/reminder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Correlation-Id","value":"08d8e413-17e7-4edb-94d8-063b53606b09"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 22 Dec 2021 01:02:47 GMT"},{"key":"Content-Length","value":"623"}],"cookie":[],"responseTime":null,"body":"{\n \"subject\": \"Invitation to take a survey at Checkbox® 7\",\n \"invitation_id\": 1032,\n \"invitation_type\": \"Email\",\n \"body\": \"

You have been invited to take the survey: 66579.

Click here to take the survey

\\n

@@FooterCompany @@FooterAddress1 @@FooterAddress2, @@FooterCity, @@FooterState @@FooterPostCode, @@FooterCountry
Unsubscribe

\\n

\"\n}"}],"_postman_id":"a3137a32-edd7-4967-922e-dca9d009a642"}],"id":"f09b85f2-abac-4f6d-aa43-2df4b81ada7b","_postman_id":"f09b85f2-abac-4f6d-aa43-2df4b81ada7b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Scheduling","item":[{"name":"Get Invitation Full Schedule","id":"95de1183-776b-4712-8386-f88c5a1c30c8","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1022/invitations/1194/schedules","description":"

This endpoint will allow you to retrieve the full schedule for this invitation. This will include Invitations and Reminders.

This endpoint can be used to pull data on a specific invitation schedule record. You can utilize this to check the status of a scheduled record to see if it has begun or completed processing.

This endpoint will allow you to schedule an invitation or reminder to send. If the invitation currently has no schedule records then the first request using this method will schedule the Invitation message to send (type: \"Invitation\"). All subsequent requests will schedule the Reminder message to send out (type: \"Reminder\").

This endpoint will allow you to send the invitation to any pending recipients for the invitation. This means any recipients that have been added to the invitation since it was last sent out.

This endpoint will allow you edit the scheduled time of an invitation or reminder. Please note that if you edit the invitation record and reminders have already been scheduled all reminders must be scheduled after the initial invitation or the reminders will not send out.

This endpoint will delete the schedule record for an invitation or reminder. Note that if you delete an invitation schedule reminders will no longer send for this invitation.

Sending out an invitation requires that you schedule the invitation. In Checkbox 6 it was possible to utilize the application without the schedule feature. Checkbox 7 was rebuilt to require scheduling. If you are not using the messaging service the schedule date / time will be ignored and your survey will be sent out immediately. If you are using the messaging service your invitation or reminder will go out at the scheduled time.

Note that all Checkbox Hosted customers have the scheduling feature enabled. Server customers will need to install the messaging service in order to schedule invitations and reminders for a future date.

\n","event":[{"listen":"prerequest","script":{"id":"554f7bc5-3a47-443b-9399-730103d99d16","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"51c8bc34-109f-4e59-b202-7fe3527023e9","type":"text/javascript","exec":[""]}}],"_postman_id":"fab3b0c6-bdf3-49f4-a212-4b39b0234fc0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Recipients","item":[{"name":"Get Invitation Panels","id":"3065ba7c-0683-4160-a9e6-0c0a645616b3","request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/surveys/1022/invitations/1194/panels","description":"

This endpoint will allow you to retrieve information on all of the recipients for your invitation, called \"Panels\". This will allow you to check who is currently on the recipient list for the invitation.

This endpoint can be utilized to pull recipient data about the invitation. This includes data on whether or not the recipients have responded to the invitation or not.

You can utilize this endpoint to add recipinets to an invitation recipient list.

Type is a required parameter. You can assign the Type of \"Contact\", \"Email\", or \"ContactGroup\". When using \"ContactGroup\" you need to use the Group Id as the value.

This endpoint will allow you to remove recipients and groups from an invitation. Doing this will make any URLs they have in their invitations invalid and generate an error.

Invitations are the Checkbox feature that allows you to send out your survey links through email using Checkbox. Each invitation recipient is tracked through the special invitation URL generated for the recipient.

Checkbox Hosted supports email schedule by default which allows you to schedule your invitations to go out in the future. Checkbox Hosted customers are also required to include an unsubscribe merge code in their email invitation before it will be processed as well as a company profile, and company profile merge codes. This is to comply with US CAN-SPAM regulation. Server customers can utilize these features but are not required by the application to do so. You may however be required by law to comply with the regulations.

Checkbox On-Premises supports email scheduling but requires the Checkbox Service to be installed in order to utilize scheduling. By default the on-premises edition will send out email as its triggered and does not support scheduling.

\n","event":[{"listen":"prerequest","script":{"id":"ce2a4278-3534-481a-bf96-b6856eceaf49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e0beea7d-122c-4ec8-ac38-5d88647c3b9e","type":"text/javascript","exec":[""]}}],"_postman_id":"9d2df62b-1e0b-4d68-9736-7ed45d7060d7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Files","item":[{"name":"Upload","id":"07448a46-47c1-457c-b6cc-d727d06d9c60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","src":"/C:/Users/kevin/Pictures/checkbox-logo.jpg"}]},"url":"{{URL}}/{{ACCOUNT_NAME}}/files/upload","description":"

This request will receive an image of type binary and then return the Checkbox URL that you can utilize in your surveys or styles.

The File API is utilized to upload images or files into Checkbox so that you can then reference them in survey questions, styles, or item options.

\n","event":[{"listen":"prerequest","script":{"id":"5a9cbc1e-97ef-469b-aa2c-6f7f2561fbf9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6de3fba4-1a7a-4fb8-9f28-83da4378dd5d","type":"text/javascript","exec":[""]}}],"_postman_id":"324e13c5-e2fe-4d7d-9aed-8bbce4d21f50","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Application Settings","item":[{"name":"Survey Settings","item":[{"name":"Get Survey Settings","id":"77b69bd4-556c-407c-85e8-b49fa30a5a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/survey","description":"

This endpoint can be utilized to get survey settings.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","application-settings","survey"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"16d829c5-a987-4b58-9488-049f3aba4df3","name":"Get Survey Settings","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/survey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1592"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 18 Dec 2018 19:49:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\r\n \"survey_preferences\": {\r\n \"default_security_type\": \"Public\",\r\n \"default_survey_style_template\": 1001,\r\n \"enable_custom_survey_urls\": true,\r\n \"allow_editing_of_active_surveys\": true,\r\n \"save_responses_when_navigating_back\": true\r\n },\r\n \"file_upload_item_settings\": {\r\n \"is_enabled\": true,\r\n \"allowed_file_types\": [\r\n {\r\n \"extension\": \".csv\",\r\n \"description\": \"Comma separated list\"\r\n },\r\n {\r\n \"extension\": \".doc\",\r\n \"description\": \"Microsoft Word document\"\r\n },\r\n {\r\n \"extension\": \".docx\",\r\n \"description\": \"Microsoft Word 2007 document\"\r\n },\r\n {\r\n \"extension\": \".gif\",\r\n \"description\": \"Graphics Interchange Format image\"\r\n },\r\n {\r\n \"extension\": \".jpeg\",\r\n \"description\": \"Joint Photographic Experts Group image\"\r\n },\r\n {\r\n \"extension\": \".jpg\",\r\n \"description\": \"Common variant of the Joint Photographic Experts Group image extension\"\r\n },\r\n {\r\n \"extension\": \".pdf\",\r\n \"description\": \"Portable Document Format\"\r\n },\r\n {\r\n \"extension\": \".png\",\r\n \"description\": \"Portable Network Graphics image\"\r\n },\r\n {\r\n \"extension\": \".ppt\",\r\n \"description\": \"Microsoft Powerpoint presentation\"\r\n },\r\n {\r\n \"extension\": \".pptx\",\r\n \"description\": \"Microsoft Powerpoint 2007 presentation\"\r\n },\r\n {\r\n \"extension\": \".txt\",\r\n \"description\": \"Text file\"\r\n },\r\n {\r\n \"extension\": \".xls\",\r\n \"description\": \"Microsoft Excel workbook\"\r\n },\r\n {\r\n \"extension\": \".xlsx\",\r\n \"description\": \"Microsoft Excel 2007 workbook\"\r\n }\r\n ],\r\n \"restrict_file_export\": true\r\n },\r\n \"advanced_survey_controls_settings\": {\r\n \"allow_javascript_item\": true,\r\n \"enable_javascript_item\": true,\r\n \"enable_survey_wide_javascript\": true,\r\n \"enable_survey_wide_css\": true\r\n }\r\n}\r\n"}],"_postman_id":"77b69bd4-556c-407c-85e8-b49fa30a5a5c"},{"name":"Edit Survey Settings","id":"08ed6c24-4415-4256-b279-6176650ebda8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_preferences\": {\n \"default_security_type\": \"Public\",\n \"default_survey_style_template\": 1002,\n \"allow_edit_survey_style_template\": true,\n \"default_question_editor_view\": \"HTML\",\n \"enable_custom_survey_urls\": true,\n \"allow_editing_of_active_surveys\": true,\n \"save_responses_when_navigating_back\": true,\n \"make_next_finish_button_as_default_button\": true,\n \"display_html_items_as_plain_text\": false,\n \"include_incomplete_responses_to_total_amount\": false\n },\n \"file_upload_item_settings\": {\n \"is_enabled\": true,\n \"allowed_file_types\": [\n {\n \"extension\": \".csv\",\n \"description\": \"Comma separated list\"\n },\n {\n \"extension\": \".doc\",\n \"description\": \"Microsoft Word document\"\n },\n {\n \"extension\": \".docx\",\n \"description\": \"Microsoft Word 2007 document\"\n },\n {\n \"extension\": \".gif\",\n \"description\": \"Graphics Interchange Format image\"\n },\n {\n \"extension\": \".jpeg\",\n \"description\": \"Joint Photographic Experts Group image\"\n },\n {\n \"extension\": \".jpg\",\n \"description\": \"Common variant of the Joint Photographic Experts Group image extension\"\n },\n {\n \"extension\": \".pdf\",\n \"description\": \"Portable Document Format\"\n },\n {\n \"extension\": \".png\",\n \"description\": \"Portable Network Graphics image\"\n },\n {\n \"extension\": \".ppt\",\n \"description\": \"Microsoft Powerpoint presentation\"\n },\n {\n \"extension\": \".pptx\",\n \"description\": \"Microsoft Powerpoint 2007 presentation\"\n },\n {\n \"extension\": \".txt\",\n \"description\": \"Text file\"\n }\n ],\n \"restrict_file_export\": false\n },\n \"advanced_survey_controls_settings\": {\n \"allow_javascript_item\": true,\n \"enable_javascript_item\": true,\n \"enable_survey_wide_javascript\": true,\n \"enable_survey_wide_css\": true\n }\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/survey","description":"

This endpoint will allow you to modify the application settings for surveys. Some of these settings will have no affect for Checkbox Online users.

Possible \"default_security_type\" values for this method are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Security Type	Meaning
Public	Survey can be completed by anyone with a link to the survey with no restrictions
PasswordProtected	Respondent must posses the password to the survey. When using this you should populate the \"survey_password\" field as well
AccessControlList	Survey is restricted to contacts and users on the access list with \"Take Survey\" permission
AllRegisteredUsers	Survey can be completed by anyone that is a registered contact or user in Checkbox
InvitationOnly	Survey can only be completed using a Checkbox generated invitation link

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","application-settings","survey"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"0177e760-0937-4ca3-83bb-6dc507eee3b1","name":"Edit Survey Settings","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_preferences\": {\n \"default_security_type\": \"Public\",\n \"default_survey_style_template\": 1002,\n \"allow_edit_survey_style_template\": true,\n \"default_question_editor_view\": \"HTML\",\n \"enable_custom_survey_urls\": true,\n \"allow_editing_of_active_surveys\": true,\n \"save_responses_when_navigating_back\": true,\n \"make_next_finish_button_as_default_button\": true,\n \"display_html_items_as_plain_text\": false,\n \"include_incomplete_responses_to_total_amount\": false\n },\n \"file_upload_item_settings\": {\n \"is_enabled\": true,\n \"allowed_file_types\": [\n {\n \"extension\": \".csv\",\n \"description\": \"Comma separated list\"\n },\n {\n \"extension\": \".doc\",\n \"description\": \"Microsoft Word document\"\n },\n {\n \"extension\": \".docx\",\n \"description\": \"Microsoft Word 2007 document\"\n },\n {\n \"extension\": \".gif\",\n \"description\": \"Graphics Interchange Format image\"\n },\n {\n \"extension\": \".jpeg\",\n \"description\": \"Joint Photographic Experts Group image\"\n },\n {\n \"extension\": \".jpg\",\n \"description\": \"Common variant of the Joint Photographic Experts Group image extension\"\n },\n {\n \"extension\": \".pdf\",\n \"description\": \"Portable Document Format\"\n },\n {\n \"extension\": \".png\",\n \"description\": \"Portable Network Graphics image\"\n },\n {\n \"extension\": \".ppt\",\n \"description\": \"Microsoft Powerpoint presentation\"\n },\n {\n \"extension\": \".pptx\",\n \"description\": \"Microsoft Powerpoint 2007 presentation\"\n },\n {\n \"extension\": \".txt\",\n \"description\": \"Text file\"\n }\n ],\n \"restrict_file_export\": false\n },\n \"advanced_survey_controls_settings\": {\n \"allow_javascript_item\": true,\n \"enable_javascript_item\": true,\n \"enable_survey_wide_javascript\": true,\n \"enable_survey_wide_css\": true\n }\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/survey"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9e07805d-5b69-4ce3-8a76-5bd9fa9a7b4c","name":"Edit Survey Settings","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"survey_preferences\": {\n \"default_security_type\": \"Public\",\n \"default_survey_style_template\": 1002,\n \"allow_edit_survey_style_template\": true,\n \"default_question_editor_view\": \"HTML\",\n \"enable_custom_survey_urls\": true,\n \"allow_editing_of_active_surveys\": true,\n \"save_responses_when_navigating_back\": true,\n \"make_next_finish_button_as_default_button\": true,\n \"display_html_items_as_plain_text\": false,\n \"include_incomplete_responses_to_total_amount\": false\n },\n \"file_upload_item_settings\": {\n \"is_enabled\": true,\n \"allowed_file_types\": [\n {\n \"extension\": \".csv\",\n \"description\": \"Comma separated list\"\n },\n {\n \"extension\": \".doc\",\n \"description\": \"Microsoft Word document\"\n },\n {\n \"extension\": \".docx\",\n \"description\": \"Microsoft Word 2007 document\"\n },\n {\n \"extension\": \".gif\",\n \"description\": \"Graphics Interchange Format image\"\n },\n {\n \"extension\": \".jpeg\",\n \"description\": \"Joint Photographic Experts Group image\"\n },\n {\n \"extension\": \".jpg\",\n \"description\": \"Common variant of the Joint Photographic Experts Group image extension\"\n },\n {\n \"extension\": \".pdf\",\n \"description\": \"Portable Document Format\"\n },\n {\n \"extension\": \".png\",\n \"description\": \"Portable Network Graphics image\"\n },\n {\n \"extension\": \".ppt\",\n \"description\": \"Microsoft Powerpoint presentation\"\n },\n {\n \"extension\": \".pptx\",\n \"description\": \"Microsoft Powerpoint 2007 presentation\"\n },\n {\n \"extension\": \".txt\",\n \"description\": \"Text file\"\n }\n ],\n \"restrict_file_export\": false\n },\n \"advanced_survey_controls_settings\": {\n \"allow_javascript_item\": true,\n \"enable_javascript_item\": true,\n \"enable_survey_wide_javascript\": true,\n \"enable_survey_wide_css\": true\n }\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/survey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1462"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 18 Dec 2018 19:51:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\r\n \"survey_preferences\": {\r\n \"default_security_type\": \"PasswordProtected\",\r\n \"default_survey_style_template\": 1001,\r\n \"enable_custom_survey_urls\": true,\r\n \"allow_editing_of_active_surveys\": true,\r\n \"save_responses_when_navigating_back\": true\r\n },\r\n \"file_upload_item_settings\": {\r\n \"is_enabled\": true,\r\n \"allowed_file_types\": [\r\n {\r\n \"extension\": \".custom\",\r\n \"description\": \"Custom file\"\r\n },\r\n {\r\n \"extension\": \".csv\",\r\n \"description\": \"Comma separated list\"\r\n },\r\n {\r\n \"extension\": \".doc\",\r\n \"description\": \"Microsoft Word document\"\r\n },\r\n {\r\n \"extension\": \".docx\",\r\n \"description\": \"Microsoft Word 2007 document\"\r\n },\r\n {\r\n \"extension\": \".gif\",\r\n \"description\": \"Graphics Interchange Format image\"\r\n },\r\n {\r\n \"extension\": \".jpeg\",\r\n \"description\": \"Joint Photographic Experts Group image\"\r\n },\r\n {\r\n \"extension\": \".jpg\",\r\n \"description\": \"Common variant of the Joint Photographic Experts Group image extension\"\r\n },\r\n {\r\n \"extension\": \".pdf\",\r\n \"description\": \"Portable Document Format\"\r\n },\r\n {\r\n \"extension\": \".png\",\r\n \"description\": \"Portable Network Graphics image\"\r\n },\r\n {\r\n \"extension\": \".ppt\",\r\n \"description\": \"Microsoft Powerpoint presentation\"\r\n },\r\n {\r\n \"extension\": \".pptx\",\r\n \"description\": \"Microsoft Powerpoint 2007 presentation\"\r\n },\r\n {\r\n \"extension\": \".txt\",\r\n \"description\": \"Text file\"\r\n },\r\n {\r\n \"extension\": \".xls\",\r\n \"description\": \"Microsoft Excel workbook\"\r\n },\r\n {\r\n \"extension\": \".xlsx\",\r\n \"description\": \"Microsoft Excel 2007 workbook\"\r\n }\r\n ],\r\n \"restrict_file_export\": true\r\n },\r\n \"advanced_survey_controls_settings\": {\r\n \"allow_javascript_item\": true,\r\n \"enable_javascript_item\": true,\r\n \"enable_survey_wide_javascript\": true,\r\n \"enable_survey_wide_css\": true\r\n }\r\n}"}],"_postman_id":"08ed6c24-4415-4256-b279-6176650ebda8"}],"id":"f4bd24f5-c783-4ed4-868d-218c15101cb2","description":"

This section will provide documentation on the API to modify the application settings relevant for surveys.

\n","_postman_id":"f4bd24f5-c783-4ed4-868d-218c15101cb2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Contact Settings","item":[{"name":"Get Contact Settings","id":"2c402f5a-5e08-4eea-b882-7948f4d6f4de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/contact","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}},"urlObject":{"path":["{{ACCOUNT_NAME}}","application-settings","contact"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e95f4a61-35dd-4d97-a440-5aaf103eb32f","name":"Get Contact Settings","originalRequest":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/contact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"871"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-Correlation-Id","value":"00000000-0000-0000-0000-000000000000"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 18 Dec 2018 19:57:02 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"registration_settings\": {\n \"allow_edit_self\": true,\n \"allow_password_reset\": true,\n \"allow_public_registration\": true,\n \"require_email_address_on_registration\": true\n },\n \"profile_properties\": [\n {\n \"id\": 1,\n \"name\": \"FirstName\",\n \"position\": 1,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 2,\n \"name\": \"LastName\",\n \"position\": 2,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 3,\n \"name\": \"ApplicationLanguage\",\n \"position\": 3,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 8,\n \"name\": \"SSN\",\n \"position\": 4,\n \"is_hidden\": false,\n \"is_system_property\": false\n },\n {\n \"id\": 11,\n \"name\": \"PhoneNumber\",\n \"position\": 5,\n \"is_hidden\": false,\n \"is_system_property\": false\n },\n {\n \"id\": 17,\n \"name\": \"Country\",\n \"position\": 6,\n \"is_hidden\": false,\n \"is_system_property\": false\n }\n ],\n \"security_settings\": {\n \"min_password_length\": null,\n \"min_password_non_alpha_numeric\": null,\n \"max_failed_login_attempts\": 3\n },\n \"single_sign_on\": {\n \"enable_jwt\": true,\n \"jwt_return_url\": \"\"\n }\n}"}],"_postman_id":"2c402f5a-5e08-4eea-b882-7948f4d6f4de"},{"name":"Edit Contact Settings","id":"614383ba-cf8d-4c07-a0f3-655e992ed27a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"registration_settings\": {\n \"allow_edit_self\": true,\n \"allow_password_reset\": true,\n \"allow_public_registration\": true,\n \"require_email_address_on_registration\": true\n },\n \"profile_properties\": [\n {\n \"id\": 1,\n \"name\": \"FirstName\",\n \"position\": 1,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 2,\n \"name\": \"LastName\",\n \"position\": 2,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 3,\n \"name\": \"ApplicationLanguage\",\n \"position\": 3,\n \"is_hidden\": false,\n \"is_system_property\": true\n },\n {\n \"id\": 8,\n \"name\": \"SSN\",\n \"position\": 4,\n \"is_hidden\": false,\n \"is_system_property\": false\n },\n {\n \"id\": 11,\n \"name\": \"PhoneNumber\",\n \"position\": 5,\n \"is_hidden\": false,\n \"is_system_property\": false\n },\n {\n \"id\": 17,\n \"name\": \"Country\",\n \"position\": 6,\n \"is_hidden\": false,\n \"is_system_property\": false\n },\n {\n \"name\": \"State\",\n \"position\": 7,\n \"is_hidden\": false,\n \"is_system_property\": false\n }\n ],\n \"security_settings\": {\n \"min_password_length\": null,\n \"min_password_non_alpha_numeric\": null,\n \"max_failed_login_attempts\": 3\n },\n \"single_sign_on\": {\n \"enable_jwt\": true,\n \"jwt_return_url\": \"\"\n }\n}"},"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/contact","description":"

This endpoint will allow you to modify the system settings related to contacts and users. This will also allow you to modify and add additional profile properties.

Additional profile properties can be added to Checkbox by adding them to the profile_properties object without an \"id\" parameter.

        {\n            \"name\": \"State\",\n            \"position\": 7,\n            \"is_hidden\": false,\n            \"is_system_property\": false\n        }\n

This section will retrieve the system settings relevent to contacts and users for Checkbox. This includes profile property settings.

\n","event":[{"listen":"prerequest","script":{"id":"518ff32f-50b6-461c-bf70-c10c067d2fc6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"55badf79-5922-4b26-9caf-83d7959e2911","type":"text/javascript","exec":[""]}}],"_postman_id":"f6c4160b-d8e6-4453-9fc1-fa213f7a38d4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Response Export Settings","item":[{"name":"Get Response Export Settings","id":"aa2108f4-0e95-47a3-b152-c19494318950","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/application-settings/response-export","description":"

This endpoint can be utilized to get the default settings for response exports. The following export types are available: \"Csv\", \"SpssCsv\", and \"SpssNative\".

This endpoint will allow you to modify the response export default settings. Possible \"default_export_type\" values for this method are: \"Csv\", \"SpssCsv\", \"SpssNative\".

This endpoint can be utilized to get report default settings.

This endpoint can be utilized to edit report default settings.

Available chart types by item type:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Item Type	Available Chart Types
radio_buttons	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
checkboxes	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
slider	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
rank_order	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
dropdown_list	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
rating	\"DoNotShow\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
single_line_text	\"DoNotShow\", \"SummaryTable\", \"ResponseDetails\", \"WordCloud\"
multi_line_text	\"DoNotShow\", \"SummaryTable\", \"ResponseDetails\", \"WordCloud\"
net_promoter_score	\"DoNotShow\", \"NetPromoterScoreTable\", \"NetPromoterScoreStatisticsTable\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
max_diff	\"DoNotShow\", \"DoNotShow\"
rating_scale	\"DoNotShow\", \"RatingScaleStatisticsTable\", \"SummaryTable\", \"ColumnGraph\", \"PieGraph\", \"LineGraph\", \"BarGraph\", \"ResponseDetails\", \"DoughnutGraph\"
matrix	\"DoNotShow\", \"MatrixSummary\"
hidden_items	\"DoNotShow\", \"SummaryTable\", \"ResponseDetails\"

This endpoint can be utilized to get survey default texts.

This endpoint can be utilized to edit survey default texts.

This endpoint can be utilized to get validation texts for the specified language.

This endpoint can be utilized to edit validation texts for a specified language.

Edit texts for multi language usage of Checkbox.

\n","_postman_id":"2779bf6a-08b7-46d9-bab0-948ee56b669e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"829fa088-5dab-43e2-869e-d8fd45f479d1","_postman_id":"829fa088-5dab-43e2-869e-d8fd45f479d1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Company Profiles","item":[{"name":"Get Company Profiles","id":"b0b1e483-74e3-484c-911b-c4a2193b53b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{URL}}/{{ACCOUNT_NAME}}/company-profiles","description":"

This endpoint can be utilized to get company profiles.

This endpoint can be utilized to create a company profile.

This endpoint can be utilized to edit a company profile.

This endpoint can be utilized to delete a company profile if the company profile isn't used in invitations.

This endpoint will hard-delete all responses that are already soft-deleted in your Checkbox account. If you are unsure if you should be removing all soft-deleted data, please use the survey-specific function below.

This function uses a retention_period_in_days value that is passed in through the body of the post request. If you do not include this parameter, or pass in a 0 as its value, it will remove ALL soft-deleted responses regardless of when they were deleted.

*Important Note: Checkbox started tracking response deletion dates as of version 7.49. This means that all responses deleted before this date will have a deleted date based on the version 7.49 release. For Checkbox hosted accounts, this date was December 16, 2021. For Checkbox on-premises installations, this would be the date that you applied the 7.49 patch.

This endpoint requires the ID of the survey that you would like to hard-delete all responses for (that have previously been soft-deleted), as well as the retention period that you would like to use.

The retention period is the number of days between when the response was deleted and today. If you use a retention period of 0, or do not provide this value in the post data, all soft-deleted responses will be permanently deleted.

Deleting survey responses in Checkbox using the admin interface or the API \"delete response\" method will soft-delete the data. This marks the responses as deleted and hides the data from the UI, API, exports and reports. Soft-deleted data still resides in the database and can generally be restored via your System tools, if needed.

For security, privacy, and/or performance reasons, you may want to completely remove this data from the database on a periodic basis. Utilizing the Hard Delete Responses endpoint, you can hard-delete responses based on filters. This operation is NOT reversible so it should be done with great care. Once this method is executed, the data will be permanently removed from the Checkbox database and cannot be restored except by restoring a database backup.

Note that these functions will only affect soft-deleted responses and will not purge any responses that have not already been deleted through the UI or API.

\n","_postman_id":"8b2a8918-ed37-42ae-987b-c974c3dc5d35","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Single Sign On ","item":[],"id":"aa08e12f-a230-41f0-b052-1d63e1628fcc","description":"

Single sign-on is a mechanism that allows you to authenticate users in your system and then tell another application (in this case Checkbox) that the user has been authenticated and should be granted access to the application. The user is then allowed to access Checkbox without being prompted to present a username or password to Checkbox directly.

Checkbox relies on a technology called JWT (JSON Web Token) for securing the exchange of user authentication data. This technology allows you to tell Checkbox, in a secure way, that users are authenticated. We are hoping to add additional methods of single sign on in the future.

Single sign-on with JWT is currently available on all plans except for the Basic Checkbox Online plan.

Additional information about JWT

JWT is an open standard that is being driven by the international standards body IETF and is backed by top-level organizations such as Microsoft, Facebook, and Google.

One thing to be aware of is that the JWT payload is merely encoded and signed, not encrypted, so make sure that you don't put any sensitive data in the claims. JWT works by serializing the JSON that is being transmitted to a string. It then base64 encodes that string and then makes an HMAC of the base64 string which depends on the shared secret key. This produces a signature that the recipient side can use to validate the user

Enabling JWT

You can enable JWT in Checkbox 7 by going to your account's application settings (clicking on your name in the top right corner) and then selecting Single Sign On.

You will want to enable the JWT feature, and then generate a JWT key. Once you generate a key the old key will automatically become invalid.

The Process

User logs into your application or web site
User click a link on your site to either create & manage surveys or to submit a survey response
Your code generates a secure JWT token and then redirects them to\nthe Checkbox application
Checkbox parses the JWT token, verifies the secure key, and then logs the user into the system\nthat matches the username in the token

Repondents

You can utilize JWT to authorize respondents when taking their survey in the same way that you can use it to authorize administrators. You will need to utilize your \"take survey URL\" which includes your subdomain, and then either the custom survey url, or the survey guid.

Here is the structure of a URL that can be used to login a respondent directly into a survey:

https://{{YOUR SUBDOMAIN}}.{{YOUR DOMAIN}}/login?jwt={{ENCODED JWT TOKEN}}&destinationURL={{CUSTOM SURVEY URL or SURVEY GUID}}

https://dev.checkbox.com/login?jwt=iOiJIUzI1NiIsInR5cCI6Ik&destinationURL=customer-satisfaction-survey\n

\n\n

Claims

In order for your token to be validated the claims must contain the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Claim Variable	Usage
uid	The contacts identifier (their username)
tid	Your account name / subdomain or use \"default\" for On-Premises accounts
iat	Same value as time_stamp (See below)
exp	An epoch timestamp in the future
time_stamp	The time since epoch (in seconds) that the token generated. Must be current or the token will be invalid

The payload should be signed using your account's JWT key.

Sample - C# Code

The sample code below is provided in C#, but you can support any language that supports generating JSON Web Tokens.

var handler = new JwtSecurityTokenHandler();\nvar key = Encoding.UTF8.GetBytes([[JWTAUthKeyFromSettings]]);\n                        \nTimeSpan t = DateTime.UtcNow.AddMinutes(3) - new DateTime(1970, 1, 1);\nint secondsSinceEpoch = (int)t.TotalSeconds;\n\nt = DateTime.UtcNow.AddMinutes(30) - new DateTime(1970, 1, 1);\nint expiration = (int)t.TotalSeconds;\n            \nvar tokenDescriptor = new SecurityTokenDescriptor\n{\n    Subject = new ClaimsIdentity(new []\n    {\n        new Claim(\"uid\", userName), \n        new Claim(\"tid\", accountName),\n        new Claim(\"jti\", Guid.NewGuid().ToString()),\n        new Claim(\"iat\", secondsSinceEpoch.ToString()),\n        new Claim(\"exp\", expiration.ToString()),\n        new Claim(\"time_stamp\", secondsSinceEpoch.ToString()), \n    }),\n    SigningCredentials = new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256)\n};\n\nvar token = handler.CreateToken(tokenDescriptor);\n\nreturn $\"https://app.checkbox.com/login?jwt={handler.WriteToken(token)}\";\n

Sample - Manual Example

This example shows you how to create a one time JWT token and login to your account with a single use JWT token.

Go to https://jwt.io/ and in the payload enter the data in the example below.
In the \"Verify signature section\" put your JWT key in place of where it says \"your-256-bit-secret\"
Copy the encoded value
Go to https://app.checkbox.com/login?jwt={{ENCODED OUTPUT FROM STEP 2}}&destinationURL={{OPTIONAL URL TO REDIRECT TO}} OR https://{{YOUR SUBDOMAIN}}/login?jwt={{ENCODED OUTPUT FROM STEP 2}}&destinationURL={{CUSTOM SURVEY URL or SURVEY GUID}}

Payload example:

{\n  \"uid\": \"{{ADMIN USERNAME ON YOUR ACCOUNT}}\",\n  \"tid\": \"{{ACCOUNT SUBDOMAIN OR BLANK FOR ON PREMISES}}\",\n  \"iat\": {{EPOCH TIME STAMP}},\n  \"jti\": \"{{random guid value}}\",\n  \"exp\": {{EPOCH TIME IN THE FUTURE}},\n  \"time_stamp\": {{EPOCH TIME STAMP}}\n}\n

(Note: to get an EPOCH timestamp you can use https://www.epochconverter.com/)

\n","event":[{"listen":"prerequest","script":{"id":"1323431f-f0b7-42dc-8793-9429f0e89a53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"59bf8b26-6e76-41e6-9b57-1279fabf837b","type":"text/javascript","exec":[""]}}],"_postman_id":"aa08e12f-a230-41f0-b052-1d63e1628fcc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Survey Customization","item":[{"name":"CSS","item":[{"name":"Body and Page Styles","item":[],"id":"429f9554-7767-4018-b20c-e5c235696553","description":"

Below you will find sample CSS with comments providing context to what the CSS is changing. You can then use the CSS selectors to write and compile your own CSS for your survey. You can add custom CSS to your survey via the advanced settings in the survey or to your style template using the style template editor.

*Please note that not all custom CSS will display in the style template preview.

/* Body Styles can be modified using the cb-take-survey-section selector as shown below */\n\n.cb-take-survey-section {\n    background: #d0b75d; /* Background Color */\n    font-size: 18px; /* Question / Answer Font Size */\n    font-family: Arial, HelveticaNeue; /* Question / Answer Font Family */\n    font-size: 18px; /* Question / Answer Font Size */\n    color: #751ca4; /* Question / Answer Font Color */\n}\n\n/* Footer / Button container styles can be modified using the cb-take-survey-buttons-container selector as shown below */\n\n.cb-take-survey-buttons-container {\n    background-color: #8be2ed; /* Footer Color */\n    height: 75px;\n}\n

\n","event":[{"listen":"prerequest","script":{"id":"7c6ac1bb-4657-43c3-a4a4-b01a51829bfd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"30225948-45ed-4d88-ad2b-cfec48ff2e2a","type":"text/javascript","exec":[""]}}],"_postman_id":"429f9554-7767-4018-b20c-e5c235696553","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Question and Item Styles","item":[],"id":"2ed0f658-c6de-46ee-b005-3ef057c5e965","description":"

This section will provide documentation on how to customize the appearance and display of specific item types and their options.

\n","event":[{"listen":"prerequest","script":{"id":"5bf58b9d-cc42-4fd4-89b3-a059d739d9b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bd98f146-d0d4-4b75-946b-25bc5a60fc04","type":"text/javascript","exec":[""]}}],"_postman_id":"2ed0f658-c6de-46ee-b005-3ef057c5e965","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}},{"name":"Ancillary Page Styles","item":[],"id":"aae53b96-a64b-45a6-a548-97a7f0729265","description":"

This section will provide documentation on how to customize the ancillary page styles for your survey. These types of pages include the login page, response selection, language selection etc.

\n","event":[{"listen":"prerequest","script":{"id":"e36adc65-fd67-4d63-bfb1-f96baea0479d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f7659606-eb25-41d4-9ef5-7b5a1b3cb997","type":"text/javascript","exec":[""]}}],"_postman_id":"aae53b96-a64b-45a6-a548-97a7f0729265","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"3b617972-7da4-4ba9-b661-80cc58881aa3","description":"

The following documentation can assit you in writing custom CSS to provide advance styling to your surveys or styling features that are not currently offered through our style template editor.

\n","event":[{"listen":"prerequest","script":{"id":"59467e72-c27d-49d1-9a35-43a3f631d1e4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6abff0c2-02e8-49f6-9c4a-96375f34b31a","type":"text/javascript","exec":[""]}}],"_postman_id":"3b617972-7da4-4ba9-b661-80cc58881aa3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"id":"e3d985b5-789c-47ca-8a2a-92d511baa9ef","description":"

Checkbox 7 has several features to help make survey customization easy and powerful. To just make basic style changes you can use our built in styles, or to make more advanced custom CSS changes we have both a survey wide CSS editor and a style CSS editor. This allows you to make custom CSS changes at both the survey or style level.

To make more advanced customizations we also offer both a javascript item and a survey wide javascript feature. You can find information on customizing your survey with CSS or Javascript below. For using the style editor please see the documentation on Checkbox.com.

\n","event":[{"listen":"prerequest","script":{"id":"2ecf20b0-0243-4169-ae2e-4352262b8f05","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ea06243e-0af7-4b92-b078-0ea1a0bb5c53","type":"text/javascript","exec":[""]}}],"_postman_id":"e3d985b5-789c-47ca-8a2a-92d511baa9ef","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","id":"bfb7796d-49f4-4f17-a6d3-675a00eb65ed","name":"Checkbox 8 API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"034c2629-63ed-4035-b89e-4f3e9c2197ec","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62c25cc7-9a57-4bb4-8004-0b77cd4c27dd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"URL","value":"{{URL}}"},{"key":"ACCOUNT_NAME","value":"{{ACCOUNT_NAME}}"},{"key":"username","value":"{{Username}}"},{"key":"password","value":"{{Password}}"},{"key":"Token","value":"{{Token}}"}]}