![\"\"](\"https://p-XwF1OejJ.b4.n0.cdn.getcloudapp.com/items/llu6N8mP/34927078-d29e-4306-a244-880a9e3f9332.gif?v=8f393425cbe3bb00be1c04b212b63578\")
Welcome to the VideoAsk API documentation!
\nOur APIs allow to create videoasks dynamically and retrieve data.
\nThe best and most painless way to retrieve responses (in real-time), is to set up response webhooks in the \"Connect 🔌**\" tab of any of your videoasks inside the app.**
\n
Check out the documentation
/ See where to find webhooks
VideoAsk
\nThe product/tool available at videoask.com
\nForm (aka videoask)
\nThe video question sequence that can be created and sent using VideoAsk.
\nQuestion (aka videoask step)
\nAn individual question/step from a form.
\nForm Author (aka creator)
\nYou! The person who creates the form.
\nContact (aka respondent)
\nThe person who responds to your form.
\nIf the Form has contact details collection enabled, the contact can have a name, an email and a phone number associated to it.
\nContacts get created on each page load of the videoask. \nAll the answers in the session will get associated with the same contact. \nHowever, if the person refreshes the page and answers the same videoask multiple times, then different contacts will be created.
\nAs the contact interacts with the videoask page, its status changes as shown in the following picture:\n![\"videoask](\"https://res.cloudinary.com/videoask/image/upload/v1598441350/public-assets/videoask-contact-status-flow.png\")
Answer
\nAn individual answer from a contact to a question.
\nResponse
\nThe group of answers from a contact to a form.
\nMessage (aka reply)
\nCan have two different author types:
\nform_author: messages sent from the form author to the contact.contact: messages sent from the contact to the form_author.Conversation
\nThe group of messages between a creator and a respondent.
\nInteraction
\nAll-encompassing term of any interaction with a contact (answers & messages).
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b793205a-59d9-45ad-8692-601437f13262","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f31afa1d-8277-4fc0-aa86-c11bce9cc07a","type":"text/javascript","exec":[""]}}],"_postman_id":"741535e7-5ee6-4b38-9bc4-17cbc51b8d7b"},{"name":"Changelog","item":[],"id":"4f790d58-4094-4e1d-ac65-057d9b973803","description":"We introduced folders endpoints:
We will change some responses from our API.
\nGET /forms\nGET /questions/<question_id>/answers\nGET /messages\nto avoid any errors or interruptions please make your applications send the query-param limit and/or offset to those endpoints.
count by default. If you need this information, send the query-param with_count=1GET /contacts/<contact_id>\nGET /threads/<thread_id>\nThis Thursday we introduced a new field in the contact form to show or not a consent check. It's called requires_consent.
Also, we included a field in contact response called consent_given, that returns if the consent was given or not.
Added the new message webhooks event types: form_author_message and form_contact_message
This Thursday we will be introducing a small breaking change on api GET /forms
respondents_count will always return 0total_count will always return 0answers_count will always return 0last_answer will always return nullLater in August we’re planning to the following changes to the same endpoint:\nremove the fields mentioned above fields all together from this endpoint\nenforce pagination
\nThis what we recommend doing in order to prepare for these changes:
\noffset and limit in the query string of GET /formsrespondents_count, use count from GET /forms/form_id/contactsanswer_count and options's total_count, use the new GET /questions/question_id/insights endpointAlways set value to authorization_code.
Temporary authorization code.
\n","key":"code","type":"text","value":"{temporary_authorization_code}"},{"description":"Unique VideoAsk client identifier.
\n","key":"client_id","type":"text","value":"{your_client_id}"},{"description":"Unique secret identifier for VideoAsk clients.
\n","key":"client_secret","type":"text","value":"{your_client_secret}"},{"description":"URL where the application should redirect. Should contain the same value as the redirect_uri you've given us when you requested API access. Used only for verification.
Now that the application has a temporary authorization code, it can request an access token with POST https://auth.videoask.com/oauth/token, sending the temporary authorization code, client_id, client_secret, and redirect_uri in the request body.
Your application's https://auth.videoask.com/oauth/token request, including the body, might look like this:
\ncurl --request POST \\\n --url https://auth.videoask.com/oauth/token \\\n --data-urlencode 'grant_type=authorization_code' \\\n --data-urlencode 'code={temporary_authorization_code}' \\\n --data-urlencode 'client_id={your_client_id}' \\\n --data-urlencode 'client_secret={your_client_secret}' \\\n --data-urlencode 'redirect_uri=https://your-example-app.com/callback'\nYour applications should then pass the access token in the Authorization header of every request.
\nAfter the token expires, your application won't be able to make requests with that token. You will need to get a new token either through the OAuth2 authentication process or by using the token refresh process (below).
\n","urlObject":{"path":["oauth","token"],"host":["https://"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d1d98f0-ab59-438e-8b88-6a5e5651d7f9"},{"name":"Refresh your application's tokens","id":"a819a7ac-774f-461d-bf3f-39ee004d3d65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"Always set value to refresh_token.
Refresh token.
\n","key":"refresh_token","type":"text","value":"{refresh_token}"},{"description":"Unique VideoAsk client identifier.
\n","key":"client_id","type":"text","value":"{your_client_id}"},{"description":"Unique secret identifier for VideoAsk clients.
\n","key":"client_secret","type":"text","value":"{your_client_secret}"}]},"url":"https:///oauth/token","description":"If your application needs to call the VideoAsk API over longer periods of time without user involvement, your application can request a special refresh token during the first authentication call, then use this refresh token to obtain new access tokens without asking for user permission each time.
\nTo receive a refresh token in the first place, your application must pass an extra offline scope during the authorization code request:
https://auth.videoask.com/authorize?response_type=code&audience=https://api.videoask.com/&client_id=${your_client_id}&scope=openid%20profile%20email%20offline_access&redirect_uri=${your_redirect_url}\n\nIf the user agrees to grant your application the required permissions, in the authorization code response to the access token exchange request, your application will receive the access_token and an extra parameter called refresh_token. You can use the value of this refresh_token parameter to obtain a new access token at any time as per RFC 6749.
curl --request POST \\\n --url https://auth.videoask.com/oauth/token \\\n --data-urlencode 'grant_type=refresh_token' \\\n --data-urlencode 'refresh_token={your_refresh_token}' \\\n --data-urlencode 'client_id={your_client_id}' \\\n --data-urlencode 'client_secret={your_client_secret}' \\\n --data-urlencode 'scope=openid profile email offline_access'\n\nThe response for this request is nearly identical to the response for the authorization code to the access token exchange request. A new access token will be returned in the response.
\n","urlObject":{"path":["oauth","token"],"host":["https://"],"query":[],"variable":[]}},"response":[],"_postman_id":"a819a7ac-774f-461d-bf3f-39ee004d3d65"}],"id":"fe1e4709-bc0b-4967-9259-d1c5b0c3151c","description":"To play around with the API you should obtain your temporary authentication token by logging into https://app.videoask.com/app and navigating to your Account > API section.
\nTo obtain your production API credentials, you should Register a new app in your Organization Settings > Developer Apps section.
\nYou can find an walkthrough guide here: https://www.videoask.com/help/integrations/360039126292-videoask-api
\nNow that we've created your app with VideoAsk, you can write the application itself using your own client_id and client_secret. Your application will need to generate an access token (and possibly also a refresh token) to integrate with VideoAsk's APIs. This requires making authorization and authentication requests through your browser-based application.
The first request, GET https://auth.videoask.com/authorize, confirms your client_id, prompts the user to grant the permissions your app requires, and returns a temporary authorization code.\nThe second request, POST https://api.videoask.com/oauth/token, confirms your temporary authorization code and returns your access token.
Your application's https://api.videoask.com/authorize link, including parameters, might look like this:
\nhttps://auth.videoask.com/authorize?response_type=code&audience=https://api.videoask.com/&client_id={your_client_id}&scope=openid%20profile%20email&redirect_uri=https://your-example-app.com/callback\nClicking the https://auth.videoask.com/authorize link in your app should redirect to the VideoAsk login screen so users can log in to their VideoAsk accounts. Then, they'll see a consent screen that lists the scope of access and prompts them to grant or deny access to your app.
\nIf the user grants access to your app, VideoAsk generates a temporary authorization code and redirects the browser to a URL that includes the code. Here's what that redirect URL might look like:
\nhttps://your-example-app.com/callback?code={temporary_authorization_code}\nRetrieve information on your account and any organization you belong to.
\n","urlObject":{"path":["organizations"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dddf2ba2-8d09-4724-b9a3-69bf5ad7fd67"},{"name":"Invite a new team member","id":"e4b347bb-b162-4c64-ba80-af691cba6b56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"hello@videoask.com\",\n\t\"role\": \"member\",\n\t\"permissions\": {\n\t\t\"default\": \"read/write\",\n\t\t\"folders\": {}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/organizations/{{organization_id}}/invitations","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"59fd99f3-2e24-4a53-893d-b82ca6702502","id":"59fd99f3-2e24-4a53-893d-b82ca6702502","name":"Organizations","type":"folder"}},"urlObject":{"path":["organizations","{{organization_id}}","invitations"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"209a6025-de28-4870-bedb-bdc3427c6ed3","name":"Invite a new team member (admin)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"hello@videoask.com\",\n\t\"role\": \"admin\",\n\t\"permissions\": {\n\t\t\"default\": \"read/write\",\n\t\t\"folders\": {}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/organizations/{{organization_id}}/invitations"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"invitation_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"role\": \"admin\",\n\t\"email\": \"hello@videoask.com\",\n\t\"permissions\": {\n\t\t\"default\": \"read/write\",\n\t\t\"folders\": {}\n\t},\n\t\"invited_at\": \"2022-08-19T18:07:54.012603Z\"\n}"},{"id":"1c4dafd9-68f8-4592-9a11-3be9055c64f1","name":"Invite a new team member (specific folders)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\": \"hello@videoask.com\",\n\t\"role\": \"member\",\n\t\"permissions\": {\n\t\t\"default\": null,\n\t\t\"folders\": {\n \"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\": \"read/write\",\n\t\t\t\"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\": \"read\" \n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/organizations/{{organization_id}}/invitations"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"invitation_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"role\": \"member\",\n\t\"email\": \"hello@videoask.com\",\n\t\"permissions\": {\n\t\t\"default\": null,\n\t\t\"folders\": {\n\t\t\t\"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\": \"read/write\",\n\t\t\t\"xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx\": \"read\" \n\t\t}\n\t},\n\t\"invited_at\": \"2022-08-19T18:41:41.767947Z\"\n}"}],"_postman_id":"e4b347bb-b162-4c64-ba80-af691cba6b56"},{"name":"Default settings for all new videoasks","id":"5924bb38-f184-471f-b36c-b10fb2ddea2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"branding\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"custom_language\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"form_settings\": {\n\t\t\"hide_branding\": false,\n\t\t\"primary_color\": \"#379CFB\",\n\t\t\"secondary_color\": \"#5CD6C8\",\n\t \"background_color\": \"#FFFFFF\",\n\t\t\"square_button_radius\": \"25\",\n\t\t\"font_family\": \"Oswald\",\n\t\t\"font_value\": \"\\\"Oswald\\\", sans-serif\",\n \"locale\": \"es-ES\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/organizations/{{organization_id}}/settings","description":"branding and custom_language parameters are optional.
VideoAsk branding is the default. To hide it, set hide_branding to true.
You'll only receive live call notifications for your forms during the working hours and days you specify.
\n⚠️ If you've invited team members to your organization, make sure all members set their working hours. Otherwise, respondents will be able to start a live call at any time of day (or night), even if you've set up your working hours as the organization owner.
\n","urlObject":{"path":["organizations","{{organization_id}}","working-schedule"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"a66f8a69-1dbe-447d-8fae-79ca3b8b4bf3","name":"Set working hours","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"working_hours_enabled\": true,\n\t\"working_start_time\": \"09:00\",\n\t\"working_end_time\": \"17:00\",\n\t\"working_days\": [\"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\"],\n\t\"working_timezone\": \"America/New_York\",\n\t\"vacation_mode_enabled\": false,\n\t\"vacation_start_date\": null,\n\t\"vacation_end_date\": null,\n\t\"vacation_timezone\": null\n}"},"url":"https://api.videoask.com/organizations/{{organization_id}}/working-schedule"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"working_hours_enabled\": true,\n\t\"working_start_time\": \"09:00\",\n\t\"working_end_time\": \"17:00\",\n\t\"working_days\": [\"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\"],\n\t\"working_timezone\": \"America/New_York\",\n\t\"vacation_mode_enabled\": false,\n\t\"vacation_start_date\": null,\n\t\"vacation_end_date\": null,\n\t\"vacation_timezone\": null\n}"},{"id":"0397e25a-37b0-4b23-81bf-d1c45288da01","name":"Set vacation mode","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"working_hours_enabled\": false,\n\t\"working_start_time\": null,\n\t\"working_end_time\": null,\n\t\"working_days\": null,\n\t\"working_timezone\": null,\n\t\"vacation_mode_enabled\": true,\n\t\"vacation_start_date\": \"2022-09-29\",\n\t\"vacation_end_date\": \"2022-10-03\",\n\t\"vacation_timezone\": \"America/Los_Angeles\"\n}"},"url":"https://api.videoask.com/organizations/{{organization_id}}/working-schedule"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"working_hours_enabled\": false,\n \"working_start_time\": null,\n \"working_end_time\": null,\n \"working_days\": null,\n \"working_timezone\": null,\n \"vacation_mode_enabled\": true,\n \"vacation_start_date\": \"2022-09-29\",\n \"vacation_end_date\": \"2022-10-03\",\n \"vacation_timezone\": \"America/Los_Angeles\"\n}"}],"_postman_id":"62f2ca0e-232e-4774-b6bc-5c56557aca30"}],"id":"59fd99f3-2e24-4a53-893d-b82ca6702502","description":"Most of the endpoints accept an optional header organization-id that will allow accessing resources from different organizations where you also have proper permissions.
Retrieves a list of JSON descriptions for all forms (videoasks) in your VideoAsk account. Forms are sorted by creation date in descending order.
\nFields for pagination:
\noffset: to indicate from which answer we want to start the pagelimit: to indicate the size of the pageSearch for form titles within your organization that match a specific keyword or search term.
\nForms are listed in chronological order; oldest forms will appear at the top of the list.
\nThe limit parameter can be used to limit how many matching forms are listed.
Use the id returned in the response to retrieve more detailed information about the specific form.
Retrieves a form by the given form_id. Includes all its questions definitions for convenience.
The response will contain full weeks report within the interval dates if interval is weekly.
For reporting purposes, weeks will start on Mondays and end on Sundays. If the dates given as start or end doesn't correspond to the exact start or end of the week, the whole week containing that date will be included in the report (see example).
\n","urlObject":{"path":["forms","form_id","metrics"],"host":["https://api.videoask.com"],"query":[{"description":{"content":"Can be daily or weekly
A date in YYYY-MM-DD format
\n","type":"text/plain"},"key":"since","value":"2020-06-01"},{"description":{"content":"A date in YYYY-MM-DD format
\n","type":"text/plain"},"key":"until","value":"2020-08-31"},{"disabled":true,"description":{"content":"Can be desktop, mobile, tablet, other or unknown
folder_id is the destination for the duplicated form. Specifying a folder_id is optional.
\nIf folder_id is not specified, the duplicated form will be added to the same folder as the original form.
\n","urlObject":{"path":["forms","form_id","duplicate"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"730e7d08-074b-4185-a818-08e401f4ca15","name":"Duplicate a form","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx\"\n}"},"url":"https://api.videoask.com/forms/form_id/duplicate"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"are_answers_public\": false,\n\t\"are_messages_public\": false,\n\t\"author_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"created_at\": \"2022-08-16T19:33:52.498482Z\",\n\t\"folder_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"hide_branding\": false,\n\t\"idle_deadline_time_in_minutes\": 60,\n\t\"metadata\": {\n\t\t\"primary_color\": \"#FA6B05\",\n\t\t\"secondary_color\": \"#FBCE37\",\n\t\t\"background_color\": \"#FFFFFF\",\n\t\t\"font_family\": \"Montserrat\",\n\t\t\"font_value\": \"\\\"Montserrat\\\", sans-serif\",\n\t\t\"locale\": \"en-US\",\n\t\t\"show_form_title\": false,\n\t\t\"live_recording\": true,\n\t\t\"show_overlay_close_button\": true,\n\t\t\"show_player_controls\": true,\n\t\t\"square_button_radius\": 10,\n\t\t\"created_from\": \"duplicate\"\n\t},\n\t\"notifications\": {\n\t\t\"send_contact_message_emails\": true\n\t},\n\t\"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"questions\": [{\n\t\t\"allowed_answer_media_types\": [\"audio\", \"video\", \"text\"],\n\t\t\"collect_contact_information\": false,\n\t\t\"created_at\": \"2022-08-16T19:33:52.518012Z\",\n\t\t\"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\t\"label\": \"1\",\n\t\t\"logic_actions\": [{\n\t\t\t\"action\": \"jump\",\n\t\t\t\"details\": {\n\t\t\t\t\"to\": {\n\t\t\t\t\t\"type\": \"goodbye\",\n\t\t\t\t\t\"value\": \"default\"\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"condition\": {\n\t\t\t\t\"op\": \"always\",\n\t\t\t\t\"vars\": []\n\t\t\t}\n\t\t}],\n\t\t\"media_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\t\"media_type\": \"video\",\n\t\t\"media_url\": \"https://player.vimeo.com/external/363031257.hd.mp4?s=0c25528f8484030b0c45da6eda102836e11a58f8&profile_id=175&oauth2_token_id=57447761\",\n\t\t\"metadata\": {},\n\t\t\"question_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\t\"share_id\": \"xxxxxxxxxxxx\",\n\t\t\"share_url\": \"https://www.videoask.com/xxxxxxxxxxx\",\n\t\t\"thumbnail\": \"https://images.pexels.com/videos/3002769/free-video-3002769.jpg?fit=crop&w=1200&h=630&auto=compress&cs=tinysrgb\",\n\t\t\"transcode_status\": \"completed\",\n\t\t\"transcribe_status\": \"completed\",\n\t\t\"type\": \"standard\",\n\t\t\"updated_at\": \"2022-08-16T19:33:52.518487Z\"\n\t}],\n\t\"requires_consent\": false,\n\t\"requires_contact_email\": true,\n\t\"requires_contact_info\": true,\n\t\"requires_contact_name\": true,\n\t\"requires_contact_phone_number\": false,\n\t\"requires_contact_product_name\": false,\n\t\"respondents_count\": 0,\n\t\"responses_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"responses_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"share_id\": \"xxxxxxxxxxxx\",\n\t\"share_url\": \"https://www.videoask.com/xxxxxxxxxxxx\",\n\t\"show_consent\": false,\n\t\"show_contact_email\": true,\n\t\"show_contact_name\": true,\n\t\"show_contact_phone_number\": false,\n\t\"show_contact_product_name\": false,\n\t\"tag_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"tag_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"title\": \"Hello World (copy)\",\n\t\"updated_at\": \"2022-08-16T19:33:52.505298Z\",\n\t\"is_password_protected\": false,\n\t\"drop_off_analysis\": true\n}"}],"_postman_id":"d85e9264-e202-4902-9953-52233481b13f"},{"name":"Move form to another organization","id":"97f9d153-d29b-4dba-8a53-8a9b2ad8356c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"new_organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}"},"url":"https://api.videoask.com/forms/form_id/move","description":"new_organization_id is the organization_id of the form's destination.
\nTo move a form from Organization A to Organization B, you must be:
\nThe form will be moved to the root folder of the organization.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"67eca8b6-7f94-4bed-9bdd-72107b4cef9e","id":"67eca8b6-7f94-4bed-9bdd-72107b4cef9e","name":"Forms","type":"folder"}},"urlObject":{"path":["forms","form_id","move"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97f9d153-d29b-4dba-8a53-8a9b2ad8356c"},{"name":"Restore a deleted form","id":"ac7b7dac-b036-44e0-917e-787847f51976","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"folder_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n"},"url":"https://api.videoask.com/forms/form_id/restore","description":"folder_id is the folder where the form will be restored. It is required.
Set folder_id to null to restore the form to your organization's root folder.
⚠️ You can only restore forms that have been deleted within the last 30 days.
\n","urlObject":{"path":["forms","form_id","restore"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"96f20824-91a9-4df3-a043-633fd57c21ea","name":"Restore a deleted form","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"folder_id\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}\n"},"url":"https://api.videoask.com/forms/form_id/restore"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"are_answers_public\": false,\n\t\"are_messages_public\": false,\n\t\"author_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"created_at\": \"2022-08-18T17:32:05.584878Z\",\n\t\"folder_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"hide_branding\": false,\n\t\"idle_deadline_time_in_minutes\": 60,\n\t\"notifications\": {\n\t\t\"send_contact_message_emails\": true\n\t},\n\t\"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"questions\": [],\n\t\"requires_consent\": false,\n\t\"requires_contact_email\": false,\n\t\"requires_contact_info\": false,\n\t\"requires_contact_name\": false,\n\t\"requires_contact_phone_number\": false,\n\t\"requires_contact_product_name\": false,\n\t\"respondents_count\": 0,\n\t\"responses_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"responses_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"share_id\": \"xxxxxxxxxx\",\n\t\"share_url\": \"https://www.videoask.com/xxxxxxxxxx\",\n\t\"show_consent\": false,\n\t\"show_contact_email\": false,\n\t\"show_contact_name\": false,\n\t\"show_contact_phone_number\": false,\n\t\"show_contact_product_name\": false,\n\t\"tag_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"tag_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"title\": \"08/18/2022\",\n\t\"updated_at\": \"2022-08-31T20:08:34.763778Z\",\n\t\"is_password_protected\": false,\n\t\"drop_off_analysis\": true\n}"}],"_postman_id":"ac7b7dac-b036-44e0-917e-787847f51976"},{"name":"Update a form","id":"f5c283e7-5704-43a5-a7f6-8a9987cd30fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My new title\",\n \"are_answers_public\": false,\n \"are_messages_public\": false\n}"},"url":"https://api.videoask.com/forms/form_id","description":"đź’ˇ PRO TIP: Click on the name of the request here in our API docs to view all of the ways in which you can update your form.
\nConsider using this third-party tool (not affiliated with or endorsed by Typeform) to convert between the required ISO 8601 time format and human-readable time.
\n","urlObject":{"path":["forms","form_id"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"16bc0651-aafd-47b4-9885-24060f4177df","name":"Schedule a close date","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"expired_at\": \"2022-08-25T20:34:15+00:00\",\n\t\"metadata\": {\n\n\t\t\"schedule_close_date_message\": \"Goodbye, world!\",\n\t\t\"expired_at_timezone\": \"America/New_York\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/forms/form_id"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"author_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"created_at\": \"2022-08-24T13:09:04.103907Z\",\n \"expired_at\": \"2022-08-25T20:34:15.000000Z\",\n \"folder_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"hide_branding\": false,\n \"idle_deadline_time_in_minutes\": 60,\n \"metadata\": {\n \"primary_color\": \"#FA6B05\",\n \"secondary_color\": \"#FBCE37\",\n \"background_color\": \"#FFFFFF\",\n \"font_family\": \"Montserrat\",\n \"font_value\": \"\\\"Montserrat\\\", sans-serif\",\n \"schedule_close_date_message\": \"Goodbye, world!\",\n \"locale\": \"en-US\",\n \"transcription_locale\": \"en-US\",\n \"filter_profanities\": false,\n \"show_form_title\": false,\n \"live_recording\": true,\n \"show_overlay_close_button\": true,\n \"show_player_controls\": true,\n \"show_subtitles_by_default\": false,\n \"pause_autoplay\": false,\n \"enhance_video_button\": false,\n \"overlay_text_color\": \"#FFFFFF\",\n \"square_button_radius\": 10,\n \"expired_at_timezone\": \"America/New_York\"\n },\n \"notifications\": {\n \"send_contact_message_emails\": true\n },\n \"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"questions\": [\n {\n \"allow_multiple_selection\": false,\n \"answers_count\": 0,\n \"collect_contact_information\": false,\n \"created_at\": \"2022-08-24T13:09:22.781088Z\",\n \"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"label\": \"1\",\n \"logic_actions\": [\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"url\",\n \"value\": \"https://www.videoask.com/xxxxxxxxxx\"\n }\n },\n \"condition\": {\n \"op\": \"is\",\n \"vars\": [\n {\n \"type\": \"question\",\n \"value\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n },\n {\n \"type\": \"option\",\n \"value\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n }\n ]\n }\n },\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"goodbye\",\n \"value\": \"default\"\n }\n },\n \"condition\": {\n \"op\": \"always\",\n \"vars\": []\n }\n }\n ],\n \"media_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"media_type\": \"video\",\n \"media_url\": \"https://player.vimeo.com/external/373966277.hd.mp4\",\n \"metadata\": {\n \"randomize_poll_options\": true\n },\n \"poll_options\": [\n {\n \"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"option_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"content\": \"Choice A\",\n \"total_count\": 0,\n \"ref\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n },\n {\n \"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"option_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"content\": \"Choice B\",\n \"total_count\": 0,\n \"ref\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n }\n ],\n \"question_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"share_id\": \"xxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxx\",\n \"thumbnail\": \"https://images.pexels.com/videos/3249935.jpg\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"poll\",\n \"updated_at\": \"2022-08-24T16:17:31.117023Z\"\n }\n ],\n \"requires_consent\": false,\n \"requires_contact_email\": false,\n \"requires_contact_info\": false,\n \"requires_contact_name\": false,\n \"requires_contact_phone_number\": false,\n \"requires_contact_product_name\": false,\n \"respondents_count\": 0,\n \"responses_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"responses_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"share_id\": \"fvog3ag3y\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxx\",\n \"show_consent\": false,\n \"show_contact_email\": false,\n \"show_contact_name\": false,\n \"show_contact_phone_number\": false,\n \"show_contact_product_name\": false,\n \"tag_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tag_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"title\": \"My VideoAsk\",\n \"updated_at\": \"2022-08-24T20:45:36.439081Z\",\n \"is_password_protected\": false,\n \"drop_off_analysis\": true\n}"}],"_postman_id":"0e04f7a5-9a3c-4b0e-85b5-b9a34223b2a7"},{"name":"Edit end screen","id":"fdd63724-234e-45d6-bde9-1d5c58b51738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\n{\n\t\"metadata\": {\n\t\t\"goodbye_screen\": {\n\t\t\t\"title\": \"Thanks for responding!\",\n\t\t\t\"subtitle\": \"We'll follow up shortly.\",\n\t\t\t\"use_brand\": true,\n\t\t\t\"background_color\": \"#379CFB\",\n\t\t\t\"show_social_media_share_buttons\": true\n\t\t}\n\t}\n}\n"},"url":"https://api.videoask.com/forms/form_id","urlObject":{"path":["forms","form_id"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"4e6fecaa-6ea6-40f8-9113-dc39bb5eeb57","name":"Edit end screen","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\n{\n\t\"metadata\": {\n\t\t\"goodbye_screen\": {\n\t\t\t\"title\": \"Thanks for responding!\",\n\t\t\t\"subtitle\": \"We'll follow up shortly.\",\n\t\t\t\"use_brand\": true,\n\t\t\t\"background_color\": \"#379CFB\",\n\t\t\t\"show_social_media_share_buttons\": true\n\t\t}\n\t}\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/forms/form_id"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"author_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"created_at\": \"2022-09-06T19:34:55.910336Z\",\n \"folder_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"hide_branding\": false,\n \"idle_deadline_time_in_minutes\": 60,\n \"metadata\": {\n \"primary_color\": \"#FA6B05\",\n \"secondary_color\": \"#FBCE37\",\n \"background_color\": \"#FFFFFF\",\n \"font_family\": \"Montserrat\",\n \"font_value\": \"\\\"Montserrat\\\", sans-serif\",\n \"locale\": \"en-US\",\n \"show_form_title\": false,\n \"live_recording\": true,\n \"show_overlay_close_button\": true,\n \"show_player_controls\": true,\n \"square_button_radius\": 10,\n \"goodbye_screen\": {\n \"title\": \"My big title\",\n \"subtitle\": \"My small title\",\n \"use_brand\": false,\n \"background_color\": \"#379CFB\",\n \"show_social_media_share_buttons\": true\n }\n },\n \"notifications\": {\n \"send_contact_message_emails\": true\n },\n \"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"questions\": [\n {\n \"allowed_answer_media_types\": [\n \"audio\",\n \"video\",\n \"text\"\n ],\n \"collect_contact_information\": false,\n \"created_at\": \"2022-09-06T19:35:00.296029Z\",\n \"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"label\": \"1\",\n \"logic_actions\": [\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"goodbye\",\n \"value\": \"default\"\n }\n },\n \"condition\": {\n \"op\": \"always\",\n \"vars\": []\n }\n }\n ],\n \"media_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"media_type\": \"video\",\n \"media_url\": \"https://player.vimeo.com/external/363031257.hd.mp4\",\n \"metadata\": {},\n \"question_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"share_id\": \"xxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxx\",\n \"thumbnail\": \"https://images.pexels.com/videos/3002769/free-video-3002769.jpg\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"standard\",\n \"updated_at\": \"2022-09-06T19:35:00.513627Z\"\n }\n ],\n \"requires_consent\": false,\n \"requires_contact_email\": false,\n \"requires_contact_info\": false,\n \"requires_contact_name\": false,\n \"requires_contact_phone_number\": false,\n \"requires_contact_product_name\": false,\n \"respondents_count\": 0,\n \"responses_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"responses_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"share_id\": \"xxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxx\",\n \"show_consent\": false,\n \"show_contact_email\": false,\n \"show_contact_name\": false,\n \"show_contact_phone_number\": false,\n \"show_contact_product_name\": false,\n \"tag_share_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tag_share_url\": \"https://www.videoask.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"title\": \"My VideoAsk\",\n \"updated_at\": \"2022-09-06T19:36:32.583221Z\",\n \"is_password_protected\": false,\n \"drop_off_analysis\": true\n}"}],"_postman_id":"fdd63724-234e-45d6-bde9-1d5c58b51738"},{"name":"Delete form","id":"de6fd118-c2d1-4341-97fa-1ba4ce5528cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/forms/form_id?soft_delete=true","urlObject":{"path":["forms","form_id"],"host":["https://api.videoask.com"],"query":[{"key":"soft_delete","value":"true"}],"variable":[]}},"response":[{"id":"54084015-8214-426c-a0db-f525afb79e05","name":"Delete form","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/forms/form_id?soft_delete=true","host":["https://api.videoask.com"],"path":["forms","form_id"],"query":[{"key":"soft_delete","value":"true"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"de6fd118-c2d1-4341-97fa-1ba4ce5528cc"}],"id":"67eca8b6-7f94-4bed-9bdd-72107b4cef9e","description":"The Forms API lets you retrieve details about the videoasks in your account. Either as a list or individually.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6ff97acf-034b-4565-8faf-50c7093f8311","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c0ee8c4c-69d1-41ca-b14f-b24f81784c85","type":"text/javascript","exec":[""]}}],"_postman_id":"67eca8b6-7f94-4bed-9bdd-72107b4cef9e"},{"name":"Filters","item":[{"name":"Filter responses","id":"9c828ca2-15e9-4d0b-bae7-984ac8257637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/forms/form_id/conversations?exclude_humans=true&limit=100&only_unread=false&only_without_tags=false&message_status=without_reply&score_gt=10&score_lt=25&tag={{tag_id}}&created_at_start_date=2022-12-01&created_at_end_date=2022-02-01&order_by=-latest_interaction","urlObject":{"protocol":"https","path":["forms","form_id","conversations"],"host":["api","videoask","com"],"query":[{"description":{"content":"Can be true or false
Can be true or false
Can be true or false
Can be without_reply or with_reply
Score greater than
\n","type":"text/plain"},"key":"score_gt","value":"10"},{"description":{"content":"Score less than
\n","type":"text/plain"},"key":"score_lt","value":"25"},{"key":"tag","value":"{{tag_id}}"},{"description":{"content":"A date in YYYY-MM-DD format
\n","type":"text/plain"},"key":"created_at_start_date","value":"2022-12-01"},{"description":{"content":"A date in YYYY-MM-DD format
\n","type":"text/plain"},"key":"created_at_end_date","value":"2022-02-01"},{"key":"order_by","value":"-latest_interaction"}],"variable":[]}},"response":[{"id":"957d9ce6-0c2b-4c10-b32a-c02a337069aa","name":"Filter responses","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/forms/form_id/conversations?exclude_humans=true&limit=100&only_unread=false&only_without_tags=false&message_status=without_reply&score_gt=10&score_lt=25&tag={{tag_id}}&created_at_start_date=2022-12-01&created_at_end_date=2022-02-01&order_by=-latest_interaction","protocol":"https","host":["api","videoask","com"],"path":["forms","form_id","conversations"],"query":[{"key":"exclude_humans","value":"true","type":"text"},{"key":"limit","value":"100"},{"key":"only_unread","value":"false"},{"key":"only_without_tags","value":"false"},{"key":"message_status","value":"without_reply"},{"key":"score_gt","value":"10"},{"key":"score_lt","value":"25"},{"key":"tag","value":"{{tag_id}}"},{"key":"created_at_start_date","value":"2022-12-01"},{"key":"created_at_end_date","value":"2022-02-01"},{"key":"order_by","value":"-latest_interaction"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"contact_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"respondent_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"name\": \"s\",\n \"product_name\": null,\n \"email\": \"s@example.com\",\n \"phone_number\": null,\n \"thumbnail\": null,\n \"status\": \"completed\",\n \"created_at\": \"2022-02-01T20:08:23.192505Z\",\n \"updated_at\": \"2022-02-01T20:08:36.974143Z\",\n \"platform\": \"desktop\",\n \"tags\": [],\n \"variables\": null,\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"share_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"consent_given\": null,\n \"scoring\": {\n \"@score\": 20\n },\n \"read\": true,\n \"latest_interaction_at\": \"2022-02-01T20:08:37.004534Z\"\n },\n {\n \"contact_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"respondent_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"name\": \"e\",\n \"product_name\": null,\n \"email\": \"e@example.com\",\n \"phone_number\": null,\n \"thumbnail\": null,\n \"status\": \"completed\",\n \"created_at\": \"2022-02-01T20:07:31.381956Z\",\n \"updated_at\": \"2022-02-01T20:07:44.724222Z\",\n \"platform\": \"desktop\",\n \"tags\": [],\n \"variables\": null,\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"share_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"consent_given\": null,\n \"scoring\": {\n \"@score\": 20\n },\n \"read\": true,\n \"latest_interaction_at\": \"2022-02-01T20:07:44.761688Z\"\n },\n {\n \"contact_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"respondent_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"name\": \"a\",\n \"product_name\": null,\n \"email\": \"a@example.com\",\n \"phone_number\": null,\n \"thumbnail\": null,\n \"status\": \"completed\",\n \"created_at\": \"2022-02-01T20:00:12.926587Z\",\n \"updated_at\": \"2022-02-01T20:00:38.425970Z\",\n \"platform\": \"desktop\",\n \"tags\": [],\n \"variables\": null,\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"share_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"consent_given\": null,\n \"scoring\": {\n \"@score\": 20\n },\n \"read\": true,\n \"latest_interaction_at\": \"2022-02-01T20:00:43.670982Z\"\n }\n ],\n \"count\": 3\n}"}],"_postman_id":"9c828ca2-15e9-4d0b-bae7-984ac8257637"}],"id":"bfa6d775-b823-45bb-9b69-7907a4fb999b","_postman_id":"bfa6d775-b823-45bb-9b69-7907a4fb999b","description":""},{"name":"Questions","item":[{"name":"Retrieve a question","id":"aeb3de15-109e-49f6-af69-3ffffb7f74a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id","description":"Retrieves a question by the given question_id.
Use this endpoint to create a question.
\nTo upload your video, send a second POST request to https://videoask-uploads-prod.s3-accelerate.amazonaws.com/, using the fields from the response of your first request as your payload for the second request.
In Python, your second POST request might look like:
\nvideo_file_path = \"/Users/andrew/Desktop/rick_roll.mov\"\nwith open(video_file_path, 'rb') as f:\n files = {'file': (video_file_path, f)}\n response = requests.request(\"POST\", \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/\", data=json_response['media_upload']['presigned_post_params']['fields'], files=files)\nprint(response.status_code)\n\nYou may want to re-use a media that was previously uploaded to VideoAsk as the video for a question. You could achieve this by passing the corresponding media_id.
By doing so, you will save storage space in your organization.
\nThe media could be a previously recorded video, a file uploaded, or VideoAsk's answer.
\n","urlObject":{"path":["questions"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"f1e3520b-1bdc-483f-9a7b-1db9f93ae3ce","name":"Create an open question with existing media","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"form_id\": \"form_id\",\n \"media_type\": \"video\",\n \"media_id\": \"{{media_id}}\",\n \"allowed_answer_media_types\": [\n \"video\",\n \"audio\",\n \"text\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/questions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 May 2020 11:11:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"591"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"POST"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"allowed_answer_media_types\": [\"audio\", \"video\", \"text\"],\n \"collect_contact_information\": false,\n \"created_at\": \"2021-10-21T13:27:20.157653Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"label\": \"3\",\n \"media_id\": \"d8fc01ad-1a5a-4163-839f-b3a5f4f519d8\",\n \"media_type\": \"video\",\n \"media_upload\": {\n \"object_key\": \"raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm\",\n \"thumbnail_object_key\": \"raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg\",\n \"presigned_url\": \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm?AWSAccessKeyId=AKIA2EBXL4QB5SPIOK7Q&Signature=ddAM1YCp4fUBn8eNMZKqhf0qTFY%3D&content-type=video%2Fwebm%3Bcodecs%3Dvp8%2Copus&Expires=1634823740\",\n \"thumbnail_presigned_url\": \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg?AWSAccessKeyId=AKIA2EBXL4QB5SPIOK7Q&Signature=WTZN9al8O1aPt%2F%2Bn7itfh24cVXQ%3D&content-type=image%2Fjpeg&Expires=1634822960\"\n },\n \"media_url\": \"https://media.videoask.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImQ4ZmMwMWFkLTFhNWEtNDE2My04MzlmLWIzYTVmNGY1MTlkOCIsImV4cCI6MTYzNTQyNzY0MH0.O8yVBTpXZNTu-q-b_OlBUVpJHPSYN2qw7ltPeKGakm8IGBKNIJq0b2G6DTnpXgsYNhCzsIZIrN4DTrfsIGrBBQWi9oO6_dxK4Q3-3tgJU5m6NGFjSUUYgRhFWcSboWrNflWkWuJsBoZh15Ae4D2NpxGpMsCbzbn1gJrofOw6qTGGFvqO4LgkEkaZgysPELJAM8r8qo0JhOLgTq_jQOBqAQr7hDOJmdPfsZBFgVc2P_NeExtTMI-Z4NPWPujx-hq47611PsarCAus2u7UNzJei5PGlJfwbSKC3EO24qw5YnIuI1GqIIp0K0__eo7KfHH3v0GYgVKSJu9F2koZrTVSceaEmqK4I5Ge8J2CnzycOBBtR44V-fT8w3EjRa9rmq7pUwoGCxDG-RHP_4KhqUwbOJuu5rpJSzuIv_vO4I5fgDZL24vs1ttjt2xpFH5b-zxVw7x-20vmbSTJsBWioUbXU4GWaXdi6_ea5zoOTvuHXuZeRHC1HbtrR0-p2UhLbXEJHxMfKC4EXUjNMKnzU03uqnHj3Uy8Pxtm8hNQ6zRHqiWHg8h1T1rfKiV7xps_w58EZ3VvkYxrFzufAg94tW15xm_E-R9GIhSd_u1eANaedsotUHu3RO3Pd454t8JVt26bKhABHYyURp3EeKN0dlEIykYXRhVwTWFlaeMGTtoKQzk\",\n \"metadata\": {},\n \"question_id\": \"3bbc53c1-d8aa-427d-a9b5-d87b0e45081c\",\n \"share_id\": \"foojemb6w\",\n \"share_url\": \"https://www.videoask.com/foojemb6w\",\n \"thumbnail\": \"https://media.videoask.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg\",\n \"transcode_status\": \"upload_pending\",\n \"transcribe_status\": \"pending\",\n \"type\": \"standard\",\n \"updated_at\": \"2021-10-21T13:27:20.158085Z\"\n}\n"},{"id":"4c47aeee-5c9d-4eb9-8e14-1cce47fa893f","name":"Create a poll with existing media","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"form_id\": \"form_id\",\n \"media_type\": \"video\",\n \"media_id\": \"{{media_id}}\",\n \"poll_options\": [\n \"Option A\",\n \"Option B\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.videoask.com/questions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 May 2020 11:14:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"734"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"POST"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"collect_contact_information\": false,\n \"created_at\": \"2021-10-21T13:27:20.157653Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"label\": \"3\",\n \"media_id\": \"d8fc01ad-1a5a-4163-839f-b3a5f4f519d8\",\n \"media_type\": \"video\",\n \"media_upload\": {\n \"object_key\": \"raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm\",\n \"thumbnail_object_key\": \"raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg\",\n \"presigned_url\": \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm?AWSAccessKeyId=AKIA2EBXL4QB5SPIOK7Q&Signature=ddAM1YCp4fUBn8eNMZKqhf0qTFY%3D&content-type=video%2Fwebm%3Bcodecs%3Dvp8%2Copus&Expires=1634823740\",\n \"thumbnail_presigned_url\": \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg?AWSAccessKeyId=AKIA2EBXL4QB5SPIOK7Q&Signature=WTZN9al8O1aPt%2F%2Bn7itfh24cVXQ%3D&content-type=image%2Fjpeg&Expires=1634822960\"\n },\n \"media_url\": \"https://media.videoask.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/video.webm?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImQ4ZmMwMWFkLTFhNWEtNDE2My04MzlmLWIzYTVmNGY1MTlkOCIsImV4cCI6MTYzNTQyNzY0MH0.O8yVBTpXZNTu-q-b_OlBUVpJHPSYN2qw7ltPeKGakm8IGBKNIJq0b2G6DTnpXgsYNhCzsIZIrN4DTrfsIGrBBQWi9oO6_dxK4Q3-3tgJU5m6NGFjSUUYgRhFWcSboWrNflWkWuJsBoZh15Ae4D2NpxGpMsCbzbn1gJrofOw6qTGGFvqO4LgkEkaZgysPELJAM8r8qo0JhOLgTq_jQOBqAQr7hDOJmdPfsZBFgVc2P_NeExtTMI-Z4NPWPujx-hq47611PsarCAus2u7UNzJei5PGlJfwbSKC3EO24qw5YnIuI1GqIIp0K0__eo7KfHH3v0GYgVKSJu9F2koZrTVSceaEmqK4I5Ge8J2CnzycOBBtR44V-fT8w3EjRa9rmq7pUwoGCxDG-RHP_4KhqUwbOJuu5rpJSzuIv_vO4I5fgDZL24vs1ttjt2xpFH5b-zxVw7x-20vmbSTJsBWioUbXU4GWaXdi6_ea5zoOTvuHXuZeRHC1HbtrR0-p2UhLbXEJHxMfKC4EXUjNMKnzU03uqnHj3Uy8Pxtm8hNQ6zRHqiWHg8h1T1rfKiV7xps_w58EZ3VvkYxrFzufAg94tW15xm_E-R9GIhSd_u1eANaedsotUHu3RO3Pd454t8JVt26bKhABHYyURp3EeKN0dlEIykYXRhVwTWFlaeMGTtoKQzk\",\n \"metadata\": {},\n \"question_id\": \"3bbc53c1-d8aa-427d-a9b5-d87b0e45081c\",\n \"share_id\": \"foojemb6w\",\n \"share_url\": \"https://www.videoask.com/foojemb6w\",\n \"thumbnail\": \"https://media.videoask.com/raw/d8fc01ad-1a5a-4163-839f-b3a5f4f519d8/thumbnail.jpeg\",\n \"transcode_status\": \"upload_pending\",\n \"transcribe_status\": \"pending\",\n \"type\": \"poll\",\n \"updated_at\": \"2021-10-21T13:27:20.158085Z\",\n \"poll_options\": [\n {\n \"id\": \"6a9822c3-a99a-4781-932f-44f8f7efa0ad\",\n \"content\": \"Option A\",\n \"total_count\": 0\n },\n {\n \"id\": \"0f6ad45d-867a-4be6-aa37-e70b439dec0b\",\n \"content\": \"Option B\",\n \"total_count\": 0\n }\n ],\n \"answers_count\": 0\n}\n"}],"_postman_id":"7416f99f-4c26-4c6f-a8ad-9441557b8ee8"},{"name":"Duplicate a question","id":"bcb55d9e-e3b7-4cfe-8685-f4b2ea013139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.videoask.com/questions/question_id/duplicate","description":"The duplicated question will be added to the form but you will need to set up logic actions to connect the duplicated question to the flow.
\n","urlObject":{"path":["questions","question_id","duplicate"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"1499d984-cb13-48c9-87c3-841097c0a5a9","name":"Duplicate a question","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.videoask.com/questions/question_id/duplicate"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"allowed_answer_media_types\": [\n \"audio\",\n \"video\",\n \"text\"\n ],\n \"collect_contact_information\": false,\n \"created_at\": \"2022-08-17T23:21:01.480682Z\",\n \"form_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"label\": \"3\",\n \"logic_actions\": [\n {\n \"action\": \"jump\",\n \"details\": {\n \"to\": {\n \"type\": \"goodbye\",\n \"value\": \"default\"\n }\n },\n \"condition\": {\n \"op\": \"always\",\n \"vars\": []\n }\n }\n ],\n \"media_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"media_type\": \"video\",\n \"media_url\": \"https://player.vimeo.com/external/328428416.hd.mp4?s=fa02b255fa889778086413be73fadec52a120743&profile_id=172&oauth2_token_id=57447761\",\n \"metadata\": {},\n \"question_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"share_id\": \"xxxxxxxxxxxx\",\n \"share_url\": \"https://www.videoask.com/xxxxxxxxxxx\",\n \"thumbnail\": \"https://images.pexels.com/videos/2098989/free-video-2098989.jpg?auto=compress&cs=tinysrgb&fit=crop&h=630&w=1200\",\n \"title\": \"(Copy) \",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"standard\",\n \"updated_at\": \"2022-08-18T21:34:38.478317Z\"\n}"}],"_postman_id":"bcb55d9e-e3b7-4cfe-8685-f4b2ea013139"},{"name":"Trim a video","id":"41449e6d-dede-4eb6-b707-525aae219542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.videoask.com/questions/question_id/trim","description":"Trim a video in a videoask step by adding the correct start and end time in milliseconds.
\n","urlObject":{"protocol":"https","path":["questions","question_id","trim"],"host":["api","videoask","com"],"query":[],"variable":[]}},"response":[{"id":"421863ae-56e5-42db-89e5-d1dd7cbbec4f","name":"Trim a video","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"start_time\": 0,\n \"end_time\": 3000\n}"},"url":"https://api.videoask.com/questions/question_id/trim"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"task_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}"}],"_postman_id":"41449e6d-dede-4eb6-b707-525aae219542"},{"name":"Update a question","id":"051a4cb5-9ad8-4a39-96bf-f64aeccd2da0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.videoask.com/questions/question_id","description":"đź’ˇ PRO TIP: Click on the name of the request here in our API docs to view all of the ways in which you can update a question.
\nUse this endpoint to generate a URL where you can upload the new video content for your question.
\nOnce you get a response, send a second POST request to https://videoask-uploads-prod.s3-accelerate.amazonaws.com/, using the fields from the first response as your payload for the second request.
In Python, your second POST request might look like:
\nvideo_file_path = \"/Users/andrew/Desktop/rick_roll.mov\"\nwith open(video_file_path, 'rb') as f:\n files = {'file': (video_file_path, f)}\n response = requests.request(\"POST\", \"https://videoask-uploads-prod.s3-accelerate.amazonaws.com/\", data=json_response['media_upload']['presigned_post_params']['fields'], files=files)\nprint(response.status_code)\nThe Folders API lets you create/update/delete the folders in your videoask account
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7ae251fc-884c-4676-b666-7d0d3b2d555d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1655eb52-14b9-4022-abf0-ef0e8631b4a0","type":"text/javascript","exec":[""]}}],"_postman_id":"6651c656-a032-4eba-b380-2fc0de4fa796"},{"name":"Responses","item":[{"name":"Retrieve single contact (with its answers and messages)","id":"4212694b-3e7c-4037-b6f6-98bda9cee2a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/forms/form_id/contacts/{{contact_id}}?include_answers=true&include_messages=true","description":"⚠️ This endpoint is subject to a rate limit of 50 requests per 5 minutes.
\n","urlObject":{"path":["forms","form_id","contacts","{{contact_id}}"],"host":["https://api.videoask.com"],"query":[{"description":{"content":"Whether or not the answers should be returned
\n","type":"text/plain"},"key":"include_answers","value":"true"},{"description":{"content":"Whether or not the conversation messages should be returned
\n","type":"text/plain"},"key":"include_messages","value":"true"}],"variable":[]}},"response":[{"id":"04d1aaf9-832b-48fe-a1a1-65354d16472e","name":"Get form contacts and answers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/forms/form_id/contacts/{{contact_id}}?include_answers=true&all_answers_transcoded=true","host":["https://api.videoask.com"],"path":["forms","form_id","contacts","{{contact_id}}"],"query":[{"key":"include_answers","value":"true"},{"key":"all_answers_transcoded","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2020 17:18:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie, Origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"contact_id\": \"988d67e0-1d24-4dcd-8456-6218cefb0c46\",\n \"name\": \"Nicolas\",\n \"email\": \"nicolas.grenie@typeform.com\",\n \"phone_number\": null,\n \"thumbnail\": \"https://media.videoask.com/transcoded/99178ec1-309d-4bab-8580-28c7bcd1b55a/thumbnails/00001.jpg\",\n \"status\": \"completed\",\n \"created_at\": \"2020-04-29T18:44:07.533577Z\",\n \"updated_at\": \"2020-04-29T18:48:32.964223Z\",\n \"answers\": [\n {\n \"answer_id\": \"9cda46d3-9127-45d3-b68c-745274df27b2\",\n \"created_at\": \"2020-04-29T18:47:12.386464Z\",\n \"media_id\": \"99178ec1-309d-4bab-8580-28c7bcd1b55a\",\n \"media_url\": \"https://media.videoask.com/transcoded/99178ec1-309d-4bab-8580-28c7bcd1b55a/video.mp4\",\n \"question_id\": \"a5966f4e-c0c3-4598-a5ce-24e05cb13a67\",\n \"share_id\": \"awuktq6t1f024q3l5gh14y0x0iw8peif3jl8rumr\",\n \"share_url\": \"https://www.videoask.com/awuktq6t1f024q3l5gh14y0x0iw8peif3jl8rumr\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/99178ec1-309d-4bab-8580-28c7bcd1b55a/thumbnails/00001.jpg\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"I'm a biker and I will love to go to med. Elin's Grant likes a nice place to buy, can discover a lot of different places. That's my next adventure.\",\n \"type\": \"video\",\n \"is_public\": false\n },\n {\n \"answer_id\": \"aaecb1c5-2f70-4562-a4fb-387339524bf4\",\n \"created_at\": \"2020-04-29T18:47:19.417654Z\",\n \"poll_option_content\": \"Yes\",\n \"poll_option_id\": \"96cb209e-7bf1-493d-a2bc-d69ab2163cc9\",\n \"question_id\": \"c271f17e-8e92-46f3-a7b9-92d973f5ef05\",\n \"type\": \"poll\",\n \"is_public\": false\n },\n {\n \"answer_id\": \"e3b7f83d-d254-43cc-b389-f67b3124d340\",\n \"created_at\": \"2020-04-29T18:48:22.731065Z\",\n \"input_text\": \"I want to bring my high school friends, we met a long time ago, and since we were 15 we've been going on a trip every year.\",\n \"question_id\": \"41dcc03b-74e2-405c-a752-5d0e7b0b67dd\",\n \"type\": \"text\",\n \"is_public\": false\n }\n ],\n \"messages\": []\n}"}],"_postman_id":"4212694b-3e7c-4037-b6f6-98bda9cee2a2"},{"name":"Retrieve question answers","id":"6f012589-1b4f-4ff4-8938-a130742a2d71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id/answers?limit=20&offset=0","description":"Get all the answers of a specific question.
\nOptional fields for pagination:
\noffset to indicate from which answer we want to start the pagelimit to indicate the size of the page⚠️ This endpoint is subject to a rate limit of 10 requests per hour. It is best practice to configure webhooks before receiving any answers, rather than fetching them after the fact using this endpoint.
\n","urlObject":{"path":["questions","question_id","answers"],"host":["https://api.videoask.com"],"query":[{"key":"limit","value":"20"},{"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"cbbdf158-7594-48ee-8453-2b74a123fcf1","name":"Retrieve question answers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id/answers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 29 Apr 2020 19:02:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"POST, GET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"answer_id\": \"bf092658-ceca-4e02-82f8-96b384c7a3d3\",\n \"contact_id\": \"a72c2058-e1d8-4b53-994f-0a33a00efb70\",\n \"contact_email\": \"jp@typeform.com\",\n \"contact_name\": \"Jean Paul\",\n \"form_id\": \"546ecd02-43c2-4c31-96e7-1670c00052e5\",\n \"form_author_id\": \"501b1ddf-9128-4a6e-abd7-60fe30b037ee\",\n \"form_hide_branding\": false,\n \"form_share_id\": \"f00nen83a\",\n \"created_at\": \"2020-04-29T19:00:48.423310Z\",\n \"media_id\": \"c6deb287-6106-4893-8764-1fc1a5b98c14\",\n \"media_url\": \"https://media.videoask.com/transcoded/c6deb287-6106-4893-8764-1fc1a5b98c14/video.mp4\",\n \"media_type\": \"video\",\n \"question_id\": \"a5966f4e-c0c3-4598-a5ce-24e05cb13a67\",\n \"share_id\": \"ayo3cvqzdr7r8bskua5ckllxqmbwbzx1l1bp4b1m\",\n \"share_url\": \"https://www.videoask.com/ayo3cvqzdr7r8bskua5ckllxqmbwbzx1l1bp4b1m\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/c6deb287-6106-4893-8764-1fc1a5b98c14/thumbnails/00001.jpg\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"Hey, I want a little Tokyo. I'm so excited by doing all the video games. Let's go!\",\n \"type\": \"video\",\n \"is_public\": false\n },\n {\n \"answer_id\": \"9cda46d3-9127-45d3-b68c-745274df27b2\",\n \"contact_id\": \"988d67e0-1d24-4dcd-8456-6218cefb0c46\",\n \"contact_email\": \"nicolas.grenie@typeform.com\",\n \"contact_name\": \"Nicolas\",\n \"form_id\": \"546ecd02-43c2-4c31-96e7-1670c00052e5\",\n \"form_author_id\": \"501b1ddf-9128-4a6e-abd7-60fe30b037ee\",\n \"form_hide_branding\": false,\n \"form_share_id\": \"f00nen83a\",\n \"created_at\": \"2020-04-29T18:47:12.386464Z\",\n \"media_id\": \"99178ec1-309d-4bab-8580-28c7bcd1b55a\",\n \"media_url\": \"https://media.videoask.com/transcoded/99178ec1-309d-4bab-8580-28c7bcd1b55a/video.mp4\",\n \"media_type\": \"video\",\n \"question_id\": \"a5966f4e-c0c3-4598-a5ce-24e05cb13a67\",\n \"share_id\": \"awuktq6t1f024q3l5gh14y0x0iw8peif3jl8rumr\",\n \"share_url\": \"https://www.videoask.com/awuktq6t1f024q3l5gh14y0x0iw8peif3jl8rumr\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/99178ec1-309d-4bab-8580-28c7bcd1b55a/thumbnails/00001.jpg\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"I'm a biker and I will love to go to med. Elin's Grant likes a nice place to buy, can discover a lot of different places. That's my next adventure.\",\n \"type\": \"video\",\n \"is_public\": false\n }\n]"}],"_postman_id":"6f012589-1b4f-4ff4-8938-a130742a2d71"},{"name":"Retrieve question insights","id":"1209eed4-e329-45e7-92b4-43c9813c937d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id/insights","urlObject":{"path":["questions","question_id","insights"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"5ef606fb-a2ed-4874-8d08-f20fd592e10b","name":"Retrieve question insights - poll question","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id/insights"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jul 2020 15:32:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"207"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.1"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"answers_count\": 197,\n \"poll_options\": [\n {\n \"id\": \"36407110-f569-4eb5-99a1-61b9ef8ce649\",\n \"content\": \"DuckDuckGo\",\n \"total_count\": 66\n },\n {\n \"id\": \"10bf15d4-2117-4dd8-9990-7486a58da277\",\n \"content\": \"Google\",\n \"total_count\": 131\n }\n ]\n}"},{"id":"867bc6a9-8c2d-4dfe-a1fb-50747e29801b","name":"Retrieve question insights - open question","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/questions/question_id/insights"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jul 2020 15:35:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.19.1"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"answers_count\": 206\n}"}],"_postman_id":"1209eed4-e329-45e7-92b4-43c9813c937d"},{"name":"Mark interaction unread","id":"dfeedcc3-0f30-407a-ab0a-a4a8869817e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"read\": false\n}"},"url":"https://api.videoask.com/conversations/{{contact_id}}/mark-read","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"053c4a4b-7dec-4bbd-8d2f-265aa87c6c03","id":"053c4a4b-7dec-4bbd-8d2f-265aa87c6c03","name":"Responses","type":"folder"}},"urlObject":{"protocol":"https","path":["conversations","{{contact_id}}","mark-read"],"host":["api","videoask","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfeedcc3-0f30-407a-ab0a-a4a8869817e7"},{"name":"Delete a response","id":"ccf2498c-faa8-455c-bb88-082cea201871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/contacts/{{contact_id}}?form_id=form_id","urlObject":{"path":["contacts","{{contact_id}}"],"host":["https://api.videoask.com"],"query":[{"key":"form_id","value":"form_id"}],"variable":[]}},"response":[{"id":"c724cdae-638e-4c89-9852-3dadbb508364","name":"Successful deletion","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/contacts/{{contact_id}}?form_id=form_id","host":["https://api.videoask.com"],"path":["contacts","{{contact_id}}"],"query":[{"key":"form_id","value":"form_id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2020 17:18:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie, Origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":""},{"id":"c7749dd5-2e9a-4be9-815a-fca0979c9c42","name":"Failed deletion","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/contacts/{{contact_id}}?form_id=form_id","host":["https://api.videoask.com"],"path":["contacts","{{contact_id}}"],"query":[{"key":"form_id","value":"form_id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2020 17:18:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie, Origin"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ccf2498c-faa8-455c-bb88-082cea201871"}],"id":"053c4a4b-7dec-4bbd-8d2f-265aa87c6c03","description":"The Responses API lets you access the data your videoasks collect — on demand and in JSON format — without setting up webhooks or third-party integrations.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4674318f-6bcc-4a60-9c04-9d33a3ef30d7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a244249f-1baf-4935-939a-f65d08893a06","type":"text/javascript","exec":[""]}}],"_postman_id":"053c4a4b-7dec-4bbd-8d2f-265aa87c6c03"},{"name":"Respondents","item":[{"name":"Create contact","id":"48ed4b01-13f2-4596-9612-b60825a91511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Johnny Rose\",\n\t\"email\": \"jr@example.com\",\n\t\"phone_number\": \"+13038675309\"\n}"},"url":"https://api.videoask.com/respondents","description":"email is the only required field; name and phone_number are optional.
You can find respondent_id in the webhook response whenever your videoask receives a new response and the respondent has provided their contact details.
You can retrieve the media_id of content by webhook, API call, or right-clicking the content, copying the video address, and finding the media_id (after /transcoded/ and before /video.mp4 in the URL).
You can retrieve the media_id of content by webhook, API call, or right-clicking the content, copying the video address, and finding the media_id (after /transcoded/ and before /video.mp4 in the URL).
Retrieves a list of JSON descriptions for all tags in your VideoAsk account.
\n","urlObject":{"path":["tags"],"host":["https://api.videoask.com"],"query":[{"description":{"content":"Indicate the size of the page
\n","type":"text/plain"},"key":"limit","value":"0"},{"description":{"content":"Indicate from which answer we want to start the page
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Filter tags by their title
\n","type":"text/plain"},"key":"title","value":null}],"variable":[]}},"response":[{"id":"12142c13-e92c-4f9d-86a3-58608ccc73d6","name":"Retrieve tags","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":{"raw":"https://api.videoask.com/tags?limit=0&offset=0&title","host":["https://api.videoask.com"],"path":["tags"],"query":[{"key":"limit","value":"0","description":"Indicate the size of the page"},{"key":"offset","value":"0","description":"Indicate from which answer we want to start the page"},{"key":"title","value":null,"description":"Filter tags by their title"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Dec 2020 11:01:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Cookie, Origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06e8c33ef00000c667a73c1000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fee3b117e1cc667-MAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"tag_id\": \"e6426810-be55-40ed-8b03-7136f90859bb\",\n \"title\": \"My tag\"\n }\n ]\n}"}],"_postman_id":"1c399f88-2241-40d0-b190-03c1aa167762"},{"name":"Create a tag","id":"2b642236-c377-4c1b-9560-82a8c88f2a77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My tag\"\n}"},"url":"https://api.videoask.com/tags","urlObject":{"path":["tags"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"1ce46289-5529-4d47-8ba2-b2ffb377cbd0","name":"Create a tag","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My tag\"\n}"},"url":"https://api.videoask.com/tags"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Dec 2020 11:01:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Cookie, Origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06e8c2ff290000c667f7239000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fee3aab7c0ec667-MAD"}],"cookie":[],"responseTime":null,"body":"{\n \"tag_id\": \"e6426810-be55-40ed-8b03-7136f90859bb\",\n \"title\": \"My tag\"\n}"}],"_postman_id":"2b642236-c377-4c1b-9560-82a8c88f2a77"},{"name":"Add a tag to a contact","id":"01458dc5-8e14-4b76-8e54-bf274d3f621e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"add\"\n}"},"url":"https://api.videoask.com/contacts/{{contact_id}}/tags/{{tag_id}}","urlObject":{"path":["contacts","{{contact_id}}","tags","{{tag_id}}"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"b0211f3f-8ece-4383-9a48-559c81372f37","name":"Add a tag to a contact","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"add\"\n}"},"url":"https://api.videoask.com/contacts/{{contact_id}}/tags/{{tag_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Dec 2020 11:02:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"PATCH, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Cookie, Origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06e8c410210000c667c02e6000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fee3c603c04c667-MAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tag_id\": \"e6426810-be55-40ed-8b03-7136f90859bb\",\n \"title\": \"My tag\"\n }\n]"}],"_postman_id":"01458dc5-8e14-4b76-8e54-bf274d3f621e"},{"name":"Remove a tag from a contact","id":"39c8784c-ba93-419e-b359-02dce5a7a1bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"remove\"\n}"},"url":"https://api.videoask.com/contacts/{{contact_id}}/tags/{{tag_id}}","urlObject":{"path":["contacts","{{contact_id}}","tags","{{tag_id}}"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"25951ca2-71b6-4811-817f-d2008d9a6150","name":"Remove a tag from a contact","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"action\": \"remove\"\n}"},"url":"https://api.videoask.com/contacts/{{contact_id}}/tags/{{tag_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Dec 2020 11:03:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"PATCH, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Cookie, Origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06e8c453990000c667c00b0000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fee3ccc2d24c667-MAD"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"39c8784c-ba93-419e-b359-02dce5a7a1bc"},{"name":"Update a tag","id":"6ac2b920-fc1a-48d6-91a6-7fc2863827a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My tag\"\n}"},"url":"https://api.videoask.com/tags/{{tag_id}}","urlObject":{"path":["tags","{{tag_id}}"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"b88975cf-2f98-41de-959a-2aaf00925026","name":"Update a tag","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"My tag\"\n}"},"url":"https://api.videoask.com/tags/{{tag_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 09 Dec 2020 11:05:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"Cookie, Origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"06e8c6da8f0000c667a6286000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"5fee40d74a59c667-MAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"tag_id\": \"e6426810-be55-40ed-8b03-7136f90859bb\",\n \"title\": \"My tag\"\n}"}],"_postman_id":"6ac2b920-fc1a-48d6-91a6-7fc2863827a4"},{"name":"Delete a tag","id":"9a4a3cbf-1ff8-4736-9848-806ecf27e42a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/tags/{{tag_id}}","urlObject":{"path":["tags","{{tag_id}}"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a4a3cbf-1ff8-4736-9848-806ecf27e42a"}],"id":"f83efcf6-3c31-4226-b918-af029f8d6bb2","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"466c361f-ca83-45c8-9afe-c81411abfa87","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7338a705-c506-410e-a6b3-9422c269a635","type":"text/javascript","exec":[""]}}],"_postman_id":"f83efcf6-3c31-4226-b918-af029f8d6bb2","description":""},{"name":"Notifications","item":[{"name":"Disable 'Human' notifications","id":"de19600e-0862-42ae-ad05-ea7e79c5727d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"form_responses\": {\n\t\t\"ignore_humans\": true\n\t}\n}"},"url":"https://api.videoask.com/organizations/{{organization_id}}/notifications","description":"Setting ignore_humans to true will prevent you from receiving email notifications when respondents answer your videoask without providing their contact details.
Once your custom language is created, you can apply it to any form using the custom_language_id value.
Refer to Forms --> Update a form --> Use custom language within the API documentation for more information.
\n","urlObject":{"path":["custom-languages"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"5f1ae512-3474-4fa7-ae69-16b2fe27b631","name":"Create custom language","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Organization-Id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"My Custom Language\",\n\t\"base_language\": \"en-US\",\n\t\"values\": {\n\t\t\"form-page.actions.answer-type-picker\": \"How would you like to answer?\",\n\t\t\"form-page.actions.video-type\": \"video\",\n\t\t\"form-page.actions.audio-type\": \"audio\",\n\t\t\"form-page.actions.text-type\": \"text\",\n\t\t\"form-page.actions.long-video-type\": \"Record your answer\",\n\t\t\"form-page.actions.long-audio-type\": \"Record your answer\",\n\t\t\"form-page.text-field.placeholder-text\": \"Type here...\",\n\t\t\"form-page.video-recorder.record-prompt\": \"Hit RECORD to start!\",\n\t\t\"form-page.video-audio.support-prompt\": \"✌️ You can practice before sending\",\n\t\t\"form-page.confirmation.approve-button\": \"YES\",\n\t\t\"form-page.confirmation.reject-button\": \"NO\",\n\t\t\"form-page.confirmation.prompt\": \"Ready to send?\",\n\t\t\"form-page.video-recorder.loading-text\": \"Firing up...\",\n\t\t\"form-page.audio-recorder.loading-text\": \"Firing up...\",\n\t\t\"form-page.poll-single-tip\": \"Choose 1 of \",\n\t\t\"form-page.poll-multi-tip\": \"Choose up to\",\n\t\t\"form-page.poll-tip-options\": \"options\",\n\t\t\"form-page.voice-speak_prompt\": \"Speak\",\n\t\t\"form-page.voice-thinking_prompt\": \"Thinking\",\n\t\t\"form-page.voice-not_understood\": \"I did not understand\",\n\t\t\"form-page.voice-try_again\": \"Try again\",\n\t\t\"form-page.actions.calendar-type\": \"Book a meeting\",\n\t\t\"form-page.thankyou.visual-or-text\": \"🙌\",\n\t\t\"form-page.thankyou.success-message\": \"All done! Thank you for answering.\",\n\t\t\"form-page.contact-form.prompt-singleStep\": \"Before you go, please leave your contact details so we can get back to you...\",\n\t\t\"form-page.contact-form.prompt-multiStep\": \"Before you go, please leave your contact details so we can get back to you...\",\n\t\t\"form-page.contact-form.placeholder-name\": \"Your name\",\n\t\t\"form-page.contact-form.placeholder-email\": \"Your email\",\n\t\t\"form-page.contact-form.placeholder-phone-number\": \"Your phone number\",\n\t\t\"form-page.contact-form.placeholder-product-name\": \"Your product name\",\n\t\t\"form-page.contact-form.invalid-email-message\": \"This e-mail looks badly formatted.\",\n\t\t\"form-page.contact-form.invalid-phone-number-message\": \"This phone number looks incorrect.\",\n\t\t\"form-page.contact-form.missing-consent\": \"Accept the terms & conditions\",\n\t\t\"form-page.contact-form.final-step-cta\": \"Send your answer\",\n\t\t\"form-page.contact-form.next-step-cta\": \"Next step\",\n\t\t\"form-page.uploading-screen.title\": \"Sending...\",\n\t\t\"form-page.uploading-screen.description-uploading\": \"We're currently uploading your response.\",\n\t\t\"form-page.uploading-screen.leaving-warning\": \"Please don't leave this page!\",\n\t\t\"form-page.uploading-banner.upload-message\": \"Uploading\",\n\t\t\"form-page.uploading-banner.leaving-warning\": \"Please don't leave this page!\",\n\t\t\"form-page.actions.time-to-interact\": \"Interact in ${seconds}s\",\n\t\t\"form-page.redirecting-screen.title\": \"Redirecting...\",\n\t\t\"form-page.uploading-screen.description-redirect-part-0\": \"We'll automatically redirect you to\",\n\t\t\"form-page.uploading-screen.description-redirect-part-1-link\": \"this url\",\n\t\t\"form-page.uploading-screen.description-redirect-part-2\": \"once the upload is finished.\",\n\t\t\"form-page.barbones-renderer.fallback-cta\": \"Reply\",\n\t\t\"form-page.live-retry.description\": \"Bummer! Looks like no one is available to take your call.\",\n\t\t\"form-page.live-retry.cta\": \"Retry call\",\n\t\t\"form-page.live-retry.rejection\": \"Never mind, let's continue\",\n\t\t\"form-page.recording-permissions.title\": \"To record video, your browser will need to request access to your camera & microphone.\",\n\t\t\"form-page.recording-permissions.button\": \"Request permissions\",\n\t\t\"form-page.in-app-instructions.dots-icon-browser\": \"To answer, please tap the " icon and then select "Open in Browser"\",\n\t\t\"form-page.in-app-instructions.dots-icon-safari\": \"To answer, please tap the " icon and then select "Open in Safari"\",\n\t\t\"form-page.in-app-instructions.dots-icon-chrome\": \"To answer, please tap the " icon and then select "Open in Chrome"\"\n\t}\n}"},"url":"https://api.videoask.com/custom-languages"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"custom_language_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"name\": \"My Custom Language\",\n\t\"base_language\": \"en-US\",\n\t\"values\": {\n\t\t\"form-page.actions.answer-type-picker\": \"How would you like to answer?\",\n\t\t\"form-page.actions.video-type\": \"video\",\n\t\t\"form-page.actions.audio-type\": \"audio\",\n\t\t\"form-page.actions.text-type\": \"text\",\n\t\t\"form-page.actions.long-video-type\": \"Record your answer\",\n\t\t\"form-page.actions.long-audio-type\": \"Record your answer\",\n\t\t\"form-page.text-field.placeholder-text\": \"Type here...\",\n\t\t\"form-page.video-recorder.record-prompt\": \"Hit RECORD to start!\",\n\t\t\"form-page.video-audio.support-prompt\": \"✌️ You can practice before sending\",\n\t\t\"form-page.confirmation.approve-button\": \"YES\",\n\t\t\"form-page.confirmation.reject-button\": \"NO\",\n\t\t\"form-page.confirmation.prompt\": \"Ready to send?\",\n\t\t\"form-page.video-recorder.loading-text\": \"Firing up...\",\n\t\t\"form-page.audio-recorder.loading-text\": \"Firing up...\",\n\t\t\"form-page.poll-single-tip\": \"Choose 1 of \",\n\t\t\"form-page.poll-multi-tip\": \"Choose up to\",\n\t\t\"form-page.poll-tip-options\": \"options\",\n\t\t\"form-page.voice-speak_prompt\": \"Speak\",\n\t\t\"form-page.voice-thinking_prompt\": \"Thinking\",\n\t\t\"form-page.voice-not_understood\": \"I did not understand\",\n\t\t\"form-page.voice-try_again\": \"Try again\",\n\t\t\"form-page.actions.calendar-type\": \"Book a meeting\",\n\t\t\"form-page.thankyou.visual-or-text\": \"🙌\",\n\t\t\"form-page.thankyou.success-message\": \"All done! Thank you for answering.\",\n\t\t\"form-page.contact-form.prompt-singleStep\": \"Before you go, please leave your contact details so we can get back to you...\",\n\t\t\"form-page.contact-form.prompt-multiStep\": \"Before you go, please leave your contact details so we can get back to you...\",\n\t\t\"form-page.contact-form.placeholder-name\": \"Your name\",\n\t\t\"form-page.contact-form.placeholder-email\": \"Your email\",\n\t\t\"form-page.contact-form.placeholder-phone-number\": \"Your phone number\",\n\t\t\"form-page.contact-form.placeholder-product-name\": \"Your product name\",\n\t\t\"form-page.contact-form.invalid-email-message\": \"This e-mail looks badly formatted.\",\n\t\t\"form-page.contact-form.invalid-phone-number-message\": \"This phone number looks incorrect.\",\n\t\t\"form-page.contact-form.missing-consent\": \"Accept the terms & conditions\",\n\t\t\"form-page.contact-form.final-step-cta\": \"Send your answer\",\n\t\t\"form-page.contact-form.next-step-cta\": \"Next step\",\n\t\t\"form-page.uploading-screen.title\": \"Sending...\",\n\t\t\"form-page.uploading-screen.description-uploading\": \"We're currently uploading your response.\",\n\t\t\"form-page.uploading-screen.leaving-warning\": \"Please don't leave this page!\",\n\t\t\"form-page.uploading-banner.upload-message\": \"Uploading\",\n\t\t\"form-page.uploading-banner.leaving-warning\": \"Please don't leave this page!\",\n\t\t\"form-page.actions.time-to-interact\": \"Interact in ${seconds}s\",\n\t\t\"form-page.redirecting-screen.title\": \"Redirecting...\",\n\t\t\"form-page.uploading-screen.description-redirect-part-0\": \"We'll automatically redirect you to\",\n\t\t\"form-page.uploading-screen.description-redirect-part-1-link\": \"this url\",\n\t\t\"form-page.uploading-screen.description-redirect-part-2\": \"once the upload is finished.\",\n\t\t\"form-page.barbones-renderer.fallback-cta\": \"Reply\",\n\t\t\"form-page.live-retry.description\": \"Bummer! Looks like no one is available to take your call.\",\n\t\t\"form-page.live-retry.cta\": \"Retry call\",\n\t\t\"form-page.live-retry.rejection\": \"Never mind, let's continue\",\n\t\t\"form-page.recording-permissions.title\": \"To record video, your browser will need to request access to your camera & microphone.\",\n\t\t\"form-page.recording-permissions.button\": \"Request permissions\",\n\t\t\"form-page.in-app-instructions.dots-icon-browser\": \"To answer, please tap the " icon and then select "Open in Browser"\",\n\t\t\"form-page.in-app-instructions.dots-icon-safari\": \"To answer, please tap the " icon and then select "Open in Safari"\",\n\t\t\"form-page.in-app-instructions.dots-icon-chrome\": \"To answer, please tap the " icon and then select "Open in Chrome"\"\n\t}\n}"}],"_postman_id":"bc59e086-db23-455d-8c2b-eb098f58bebe"}],"id":"c3d963f2-8098-4b96-901f-b50a0aa1ae30","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"89f503ee-b8e1-4a1a-8b3d-61792738495f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7861343d-a286-4d0a-97bc-5a51f8f30cb4","type":"text/javascript","exec":[""]}}],"_postman_id":"c3d963f2-8098-4b96-901f-b50a0aa1ae30","description":""},{"name":"Webhooks","item":[{"name":"Retrieve webhooks","id":"0f3784d2-5c16-4684-af0f-905fbbd75042","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/forms/form_id/webhooks","description":"Retrieve all webhooks for the specified videoask.
\n","urlObject":{"path":["forms","form_id","webhooks"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0f3784d2-5c16-4684-af0f-905fbbd75042"},{"name":"Retrieve single webhook","id":"a08f9b2a-469d-4023-bab1-04dd367ad391","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"url":"https://api.videoask.com/forms/form_id/webhooks/{{tag}}","description":"Retrieve a single webhook.
\ntag is what you named your webhook when creating it via the VideoAsk API.
If you created your webhook via the VideoAsk web interface, you can find your webhook's randomly-generated tag using the \"Retrieve webhooks\" endpoint.
Create or update webhook.
\nIf you're creating a webhook, add a tag/unique identifier to the end of the URL (e.g. hubspot-webhook). Tags help you easily distinguish webhooks when you want to retrieve, update, or delete them.
If you're updating a webhook that you created via the VideoAsk web interface, you can find your webhook's randomly-generated tag using the \"Retrieve webhooks\" endpoint.
Delete a webhook.
\ntag is what you named your webhook when creating it via the VideoAsk API.
If you created your webhook via the VideoAsk web interface, you can find your webhook's randomly-generated tag using the \"Retrieve webhooks\" endpoint.
Where do you want to send your videoask’s data? With our Webhooks API, you can send every response straight to any URL or compatible web application as soon as it’s submitted or when it's finished transcribing.
\nYou can set them up in the Connect tab of your videoask, or by using the endpoints described here.
Webhooks are notifications that are triggered automatically when a specific event occurs and sent through the web. With the VideoAsk Webhooks API, the event can be a new response submission or a new response submission after the transcription process finished. When a new event comes in, a notification that contains the response data is immediately sent to your chosen destination: the URL or web application you set. Your webhook endpoint should accept our POST request and send back a 2XX HTTP response status code to let us know that you received the webhook data successfully.
If a webhook request fails for any reason, VideoAsk will retry the request to your endpoint 3 times using a back-off mechanism after 5, 10, and 20 minutes.
\nform_responseTriggers as soon as a videoask is completed/abandoned and all video/audio media is transcoded.
\nExample payload:
\n\n{\n \"event_id\": \"7df19833701662b6414ed1765dcc626c\",\n \"event_type\": \"form_response\",\n \"interaction_id\": \"386bbc0b-bb60-4b62-82fa-d630d0d2b83b\",\n \"contact\": {\n \"contact_id\": \"7c6550ff-fe15-424a-918e-2c1936db8aed\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_number\": null,\n \"thumbnail\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej-00001.jpg\",\n \"status\": \"completed\",\n \"created_at\": \"2020-03-30T16:04:09.021715Z\",\n \"updated_at\": \"2020-03-30T16:05:08.952236Z\",\n \"answers\": [\n {\n \"answer_id\": \"0f4ab93a-4914-4e4a-a33b-8466fda6147a\",\n \"created_at\": \"2020-03-30T16:04:09.353595Z\",\n \"poll_option_content\": \"Grapes\",\n \"poll_option_id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"type\": \"poll\"\n },\n {\n \"answer_id\": \"995948a9-8a02-48f8-a018-769f0f25e7f8\",\n \"created_at\": \"2020-03-30T16:05:05.434020Z\",\n \"media_url\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej.mp4\",\n \"media_duration\": 6,\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"share_id\": \"a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej\",\n \"share_url\": \"https://www.videoask.com/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej-00001.jpg\",\n \"transcode_status\": \"completed\",\n \"type\": \"video\"\n }\n ]\n },\n \"form\": {\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"title\": \"Example form for documentation\",\n \"requires_contact_info\": true,\n \"requires_contact_email\": true,\n \"requires_contact_name\": true,\n \"requires_contact_phone_number\": false,\n \"hide_branding\": false,\n \"metadata\": {\n \"primary_color\": \"#522CBB\",\n \"secondary_color\": \"#4CD982\",\n \"locale\": \"en-US\",\n \"show_form_title\": true\n },\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"created_at\": \"2020-03-30T15:53:59.331687Z\",\n \"updated_at\": \"2020-03-30T15:57:11.330236Z\",\n \"respondents_count\": 2,\n \"author_id\": \"8a484e48-2e8e-423d-8d91-b1d6c98b60f2\",\n \"questions\": [\n {\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"metadata\": {\n \"text\": \"What's your favorite fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"type\": \"poll\",\n \"share_id\": \"ql0eet9ga\",\n \"share_url\": \"https://www.videoask.com/ql0eet9ga\",\n \"created_at\": \"2020-03-30T15:53:59.697150Z\",\n \"updated_at\": \"2020-03-30T15:57:11.319072Z\",\n \"thumbnail\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy-preview.gif?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy.mp4?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy.mp4\",\n \"poll_options\": [\n {\n \"id\": \"27b7cd85-db1e-4316-8dbe-772523feb098\",\n \"content\": \"Bananas\"\n },\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\"\n },\n {\n \"id\": \"b15efc9c-ae2e-4254-b653-50c8ef2b7364\",\n \"content\": \"Apples\"\n },\n {\n \"id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"content\": \"Grapes\"\n },\n {\n \"id\": \"6daada9f-cc7b-4ffe-9529-f16f35517770\",\n \"content\": \"Other\"\n }\n ]\n },\n {\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"metadata\": {\n \"text\": \"Why do you love that fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"type\": \"standard\",\n \"allowed_answer_media_types\": [\n \"video\",\n \"audio\",\n \"text\"\n ],\n \"share_id\": \"qrv6rnyg3\",\n \"share_url\": \"https://www.videoask.com/qrv6rnyg3\",\n \"created_at\": \"2020-03-30T15:57:10.931514Z\",\n \"updated_at\": \"2020-03-30T15:57:11.324552Z\",\n \"thumbnail\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy-preview.gif?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy.mp4?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy.mp4\"\n }\n ]\n }\n}\nform_response_transcribedTriggers as soon as a videoask is completed/abandoned and all video/audio media is transcoded and transcribed (can at times take up to 3-4min).
\nExample payload:
\n{\n \"event_id\": \"1cc057d1a8acc59ed2ed7a7cd5edbf1b\",\n \"event_type\": \"form_response_transcribed\",\n \"interaction_id\": \"386bbc0b-bb60-4b62-82fa-d630d0d2b83b\",\n \"contact\": {\n \"contact_id\": \"7c6550ff-fe15-424a-918e-2c1936db8aed\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone_number\": null,\n \"thumbnail\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej-00001.jpg\",\n \"status\": \"completed\",\n \"created_at\": \"2020-03-30T16:04:09.021715Z\",\n \"updated_at\": \"2020-03-30T16:05:08.952236Z\",\n \"answers\": [\n {\n \"answer_id\": \"0f4ab93a-4914-4e4a-a33b-8466fda6147a\",\n \"created_at\": \"2020-03-30T16:04:09.353595Z\",\n \"poll_option_content\": \"Grapes\",\n \"poll_option_id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"type\": \"poll\"\n },\n {\n \"answer_id\": \"995948a9-8a02-48f8-a018-769f0f25e7f8\",\n \"created_at\": \"2020-03-30T16:05:05.434020Z\",\n \"media_url\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej.mp4\",\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"share_id\": \"a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej\",\n \"share_url\": \"https://www.videoask.com/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/a8v1jwbdwwc7uq0keni9kf0c5l42vt42gp23f4ej-00001.jpg\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"I don't actually know, but once I start eating them, I can never stop.\",\n \"type\": \"video\"\n }\n ]\n },\n \"form\": {\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"title\": \"Example form for documentation\",\n \"requires_contact_info\": true,\n \"requires_contact_email\": true,\n \"requires_contact_name\": true,\n \"requires_contact_phone_number\": false,\n \"hide_branding\": false,\n \"metadata\": {\n \"primary_color\": \"#522CBB\",\n \"secondary_color\": \"#4CD982\",\n \"locale\": \"en-US\",\n \"show_form_title\": true\n },\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"created_at\": \"2020-03-30T15:53:59.331687Z\",\n \"updated_at\": \"2020-03-30T15:57:11.330236Z\",\n \"author_id\": \"8a484e48-2e8e-423d-8d91-b1d6c98b60f2\",\n \"questions\": [\n {\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"metadata\": {\n \"text\": \"What's your favorite fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"type\": \"poll\",\n \"share_id\": \"ql0eet9ga\",\n \"share_url\": \"https://www.videoask.com/ql0eet9ga\",\n \"created_at\": \"2020-03-30T15:53:59.697150Z\",\n \"updated_at\": \"2020-03-30T15:57:11.319072Z\",\n \"thumbnail\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy-preview.gif?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy.mp4?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy.mp4\",\n \"poll_options\": [\n {\n \"id\": \"27b7cd85-db1e-4316-8dbe-772523feb098\",\n \"content\": \"Bananas\"\n },\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\"\n },\n {\n \"id\": \"b15efc9c-ae2e-4254-b653-50c8ef2b7364\",\n \"content\": \"Apples\"\n },\n {\n \"id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"content\": \"Grapes\"\n },\n {\n \"id\": \"6daada9f-cc7b-4ffe-9529-f16f35517770\",\n \"content\": \"Other\"\n }\n ]\n },\n {\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"metadata\": {\n \"text\": \"Why do you love that fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"type\": \"standard\",\n \"allowed_answer_media_types\": [\n \"video\",\n \"audio\",\n \"text\"\n ],\n \"share_id\": \"qrv6rnyg3\",\n \"share_url\": \"https://www.videoask.com/qrv6rnyg3\",\n \"created_at\": \"2020-03-30T15:57:10.931514Z\",\n \"updated_at\": \"2020-03-30T15:57:11.324552Z\",\n \"thumbnail\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy-preview.gif?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy.mp4?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy.mp4\"\n }\n ]\n }\n}\nform_author_messageTriggers as soon as message is sent by the videoask creator to the contact and the video/audio media is transcoded and transcribed.
\n{\n \"event_id\": \"a69aeb109cd0c1408e71c3836e84e74f\",\n \"event_type\": \"form_author_message\",\n \"contact\": {\n \"contact_id\": \"6f0cde71-546c-499b-8cdb-c661300fb7f3\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"status\": \"completed\",\n \"created_at\": \"2020-08-13T09:07:25.501318Z\",\n \"updated_at\": \"2020-08-13T09:07:55.461776Z\",\n \"answers\": [\n {\n \"answer_id\": \"f0f5a564-1f46-49e9-b579-731e6e3f9c4e\",\n \"created_at\": \"2020-08-13T09:07:31.216396Z\",\n \"is_public\": false,\n \"poll_options\": [\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\"\n }\n ],\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"type\": \"poll\",\n \"poll_option_id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"poll_option_content\": \"Strawberries\"\n },\n {\n \"answer_id\": \"6254f48a-a29d-4623-9525-9a8aeab9b5dc\",\n \"created_at\": \"2020-08-13T09:07:55.181435Z\",\n \"input_text\": \"Bacause they're tasty!\",\n \"is_public\": false,\n \"poll_options\": [],\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"type\": \"text\"\n }\n ],\n \"messages\": [\n {\n \"author_type\": \"form_author\",\n \"created_at\": \"2020-08-13T09:09:47.351432Z\",\n \"gif\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/preview.gif?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"is_public\": true,\n \"media_duration\": 9,\n \"media_type\": \"video\",\n \"media_url\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/video.mp4?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"message_id\": \"e4d547ca-e29b-47cb-9096-8f8bbafedde2\",\n \"share_id\": \"mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"share_url\": \"https://www.videoask.com/mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"thread_id\": \"95ae6155-f970-4d18-9116-191777fef28a\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/image.0000001.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"transcription\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\",\n \"transcription_data\": [\n {\n \"words\": [\n {\n \"word\": \"Hello,\",\n \"end_time\": 1.1,\n \"start_time\": 0.8\n },\n {\n \"word\": \"John.\",\n \"end_time\": 1.5,\n \"start_time\": 1.1\n },\n {\n \"word\": \"Thank\",\n \"end_time\": 1.7,\n \"start_time\": 1.5\n },\n {\n \"word\": \"you\",\n \"end_time\": 1.8,\n \"start_time\": 1.7\n },\n {\n \"word\": \"so\",\n \"end_time\": 1.9,\n \"start_time\": 1.8\n },\n {\n \"word\": \"much\",\n \"end_time\": 2.1,\n \"start_time\": 1.9\n },\n {\n \"word\": \"for\",\n \"end_time\": 2.3,\n \"start_time\": 2.1\n },\n {\n \"word\": \"your\",\n \"end_time\": 2.4,\n \"start_time\": 2.3\n },\n {\n \"word\": \"response.\",\n \"end_time\": 3.1,\n \"start_time\": 2.4\n },\n {\n \"word\": \"Can\",\n \"end_time\": 4,\n \"start_time\": 3.9\n },\n {\n \"word\": \"you\",\n \"end_time\": 4.1,\n \"start_time\": 4\n },\n {\n \"word\": \"please\",\n \"end_time\": 4.8,\n \"start_time\": 4.1\n },\n {\n \"word\": \"explain\",\n \"end_time\": 5.3,\n \"start_time\": 4.8\n },\n {\n \"word\": \"have\",\n \"end_time\": 5.5,\n \"start_time\": 5.3\n },\n {\n \"word\": \"it\",\n \"end_time\": 5.6,\n \"start_time\": 5.5\n },\n {\n \"word\": \"better?\",\n \"end_time\": 6.1,\n \"start_time\": 5.6\n },\n {\n \"word\": \"Why\",\n \"end_time\": 6.3,\n \"start_time\": 6.1\n },\n {\n \"word\": \"do\",\n \"end_time\": 6.4,\n \"start_time\": 6.3\n },\n {\n \"word\": \"you\",\n \"end_time\": 6.5,\n \"start_time\": 6.4\n },\n {\n \"word\": \"love\",\n \"end_time\": 6.7,\n \"start_time\": 6.5\n },\n {\n \"word\": \"strawberries?\",\n \"end_time\": 7.5,\n \"start_time\": 6.7\n },\n {\n \"word\": \"Thank\",\n \"end_time\": 8.2,\n \"start_time\": 8\n },\n {\n \"word\": \"you.\",\n \"end_time\": 8.5,\n \"start_time\": 8.2\n }\n ],\n \"confidence\": 0.90139115,\n \"transcript\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\"\n }\n ],\n \"type\": \"video\"\n }\n ],\n \"platform\": \"desktop\",\n \"tags\": [],\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"share_id\": \"c3rqviz79cva7xmuoo70rva4l5fi699isbzvxjym\",\n \"share_url\": \"https://www.videoask.com/c3rqviz79cva7xmuoo70rva4l5fi699isbzvxjym\"\n },\n \"form\": {\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"title\": \"Example form for documentation\",\n \"requires_contact_info\": true,\n \"requires_contact_email\": true,\n \"requires_contact_name\": true,\n \"requires_contact_phone_number\": false,\n \"hide_branding\": false,\n \"metadata\": {\n \"primary_color\": \"#522CBB\",\n \"secondary_color\": \"#4CD982\",\n \"locale\": \"en-US\",\n \"show_form_title\": true\n },\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"created_at\": \"2020-03-30T15:53:59.331687Z\",\n \"updated_at\": \"2020-04-23T08:40:51.775168Z\",\n \"respondents_count\": 13,\n \"author_id\": \"8a484e48-2e8e-423d-8d91-b1d6c98b60f2\",\n \"questions\": [\n {\n \"answers_count\": 9,\n \"created_at\": \"2020-03-30T15:53:59.697150Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"media_id\": \"e627bdd1-a9db-41a9-80db-a6546c9c6ba6\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy.mp4?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy.mp4\",\n \"metadata\": {\n \"text\": \"What's your favorite fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"poll_options\": [\n {\n \"id\": \"27b7cd85-db1e-4316-8dbe-772523feb098\",\n \"content\": \"Bananas\",\n \"total_count\": 3\n },\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\",\n \"total_count\": 4\n },\n {\n \"id\": \"b15efc9c-ae2e-4254-b653-50c8ef2b7364\",\n \"content\": \"Apples\",\n \"total_count\": 0\n },\n {\n \"id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"content\": \"Grapes\",\n \"total_count\": 1\n },\n {\n \"id\": \"6daada9f-cc7b-4ffe-9529-f16f35517770\",\n \"content\": \"Other\",\n \"total_count\": 1\n }\n ],\n \"allow_multiple_selection\": false,\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"thumbnail\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy-preview.gif?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"poll\",\n \"updated_at\": \"2020-03-30T15:57:11.319072Z\"\n },\n {\n \"allowed_answer_media_types\": [\n \"video\",\n \"audio\",\n \"text\"\n ],\n \"created_at\": \"2020-03-30T15:57:10.931514Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"media_id\": \"8031b331-c5e1-4fda-8523-314c2fa5cdd8\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy.mp4?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy.mp4\",\n \"metadata\": {\n \"text\": \"Why do you love that fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"allow_multiple_selection\": false,\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"thumbnail\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy-preview.gif?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"standard\",\n \"updated_at\": \"2020-03-30T15:57:11.324552Z\"\n }\n ],\n \"are_answers_public\": false,\n \"notifications\": {\n \"send_contact_message_emails\": true\n }\n },\n \"message\": {\n \"author_type\": \"form_author\",\n \"created_at\": \"2020-08-13T09:09:47.351432Z\",\n \"gif\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/preview.gif?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"is_public\": true,\n \"media_duration\": 9,\n \"media_type\": \"video\",\n \"media_url\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/video.mp4?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"message_id\": \"e4d547ca-e29b-47cb-9096-8f8bbafedde2\",\n \"share_id\": \"mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"share_url\": \"https://www.videoask.com/mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"thread_id\": \"95ae6155-f970-4d18-9116-191777fef28a\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/image.0000001.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"transcription\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\",\n \"transcription_data\": [\n {\n \"transcript\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\",\n \"confidence\": 0.90139115,\n \"words\": [\n {\n \"word\": \"Hello,\",\n \"start_time\": 0.8,\n \"end_time\": 1.1\n },\n {\n \"word\": \"John.\",\n \"start_time\": 1.1,\n \"end_time\": 1.5\n },\n {\n \"word\": \"Thank\",\n \"start_time\": 1.5,\n \"end_time\": 1.7\n },\n {\n \"word\": \"you\",\n \"start_time\": 1.7,\n \"end_time\": 1.8\n },\n {\n \"word\": \"so\",\n \"start_time\": 1.8,\n \"end_time\": 1.9\n },\n {\n \"word\": \"much\",\n \"start_time\": 1.9,\n \"end_time\": 2.1\n },\n {\n \"word\": \"for\",\n \"start_time\": 2.1,\n \"end_time\": 2.3\n },\n {\n \"word\": \"your\",\n \"start_time\": 2.3,\n \"end_time\": 2.4\n },\n {\n \"word\": \"response.\",\n \"start_time\": 2.4,\n \"end_time\": 3.1\n },\n {\n \"word\": \"Can\",\n \"start_time\": 3.9,\n \"end_time\": 4\n },\n {\n \"word\": \"you\",\n \"start_time\": 4,\n \"end_time\": 4.1\n },\n {\n \"word\": \"please\",\n \"start_time\": 4.1,\n \"end_time\": 4.8\n },\n {\n \"word\": \"explain\",\n \"start_time\": 4.8,\n \"end_time\": 5.3\n },\n {\n \"word\": \"have\",\n \"start_time\": 5.3,\n \"end_time\": 5.5\n },\n {\n \"word\": \"it\",\n \"start_time\": 5.5,\n \"end_time\": 5.6\n },\n {\n \"word\": \"better?\",\n \"start_time\": 5.6,\n \"end_time\": 6.1\n },\n {\n \"word\": \"Why\",\n \"start_time\": 6.1,\n \"end_time\": 6.3\n },\n {\n \"word\": \"do\",\n \"start_time\": 6.3,\n \"end_time\": 6.4\n },\n {\n \"word\": \"you\",\n \"start_time\": 6.4,\n \"end_time\": 6.5\n },\n {\n \"word\": \"love\",\n \"start_time\": 6.5,\n \"end_time\": 6.7\n },\n {\n \"word\": \"strawberries?\",\n \"start_time\": 6.7,\n \"end_time\": 7.5\n },\n {\n \"word\": \"Thank\",\n \"start_time\": 8,\n \"end_time\": 8.2\n },\n {\n \"word\": \"you.\",\n \"start_time\": 8.2,\n \"end_time\": 8.5\n }\n ]\n }\n ],\n \"type\": \"video\"\n }\n}\nform_contact_messageTriggers as soon as message is sent by the contact and the video/audio media is transcoded and transcribed.
\n{\n \"event_id\": \"35f63f63c4c31d04a938d5b279a6a4e6\",\n \"event_type\": \"form_contact_message\",\n \"interaction_id\": \"386bbc0b-bb60-4b62-82fa-d630d0d2b83b\",\n \"contact\": {\n \"contact_id\": \"6f0cde71-546c-499b-8cdb-c661300fb7f3\",\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"status\": \"completed\",\n \"created_at\": \"2020-08-13T09:07:25.501318Z\",\n \"updated_at\": \"2020-08-13T09:07:55.461776Z\",\n \"answers\": [\n {\n \"answer_id\": \"f0f5a564-1f46-49e9-b579-731e6e3f9c4e\",\n \"created_at\": \"2020-08-13T09:07:31.216396Z\",\n \"is_public\": false,\n \"poll_options\": [\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\"\n }\n ],\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"type\": \"poll\",\n \"poll_option_id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"poll_option_content\": \"Strawberries\"\n },\n {\n \"answer_id\": \"6254f48a-a29d-4623-9525-9a8aeab9b5dc\",\n \"created_at\": \"2020-08-13T09:07:55.181435Z\",\n \"input_text\": \"Bacause they're tasty!\",\n \"is_public\": false,\n \"poll_options\": [],\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"type\": \"text\"\n }\n ],\n \"messages\": [\n {\n \"author_type\": \"form_author\",\n \"created_at\": \"2020-08-13T09:09:47.351432Z\",\n \"gif\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/preview.gif?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"is_public\": true,\n \"media_duration\": 9,\n \"media_type\": \"video\",\n \"media_url\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/video.mp4?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"message_id\": \"e4d547ca-e29b-47cb-9096-8f8bbafedde2\",\n \"share_id\": \"mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"share_url\": \"https://www.videoask.com/mctlhdikwzcxs0f618gu5mn247pexyxuqpbvodny\",\n \"thread_id\": \"95ae6155-f970-4d18-9116-191777fef28a\",\n \"thumbnail\": \"https://media.videoask.com/transcoded/b3286b15-8722-44ad-99dd-ef643f0bb9da/thumbnails/image.0000001.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJtZWRpYV9pZCI6ImIzMjg2YjE1LTg3MjItNDRhZC05OWRkLWVmNjQzZjBiYjlkYSIsImV4cCI6MTU5NzkxNDU4N30.sUyDJaJVDlaCTtwXIeytwRwNS9wHLSTge15owz3La2deuJLJd1xLuEEyS35F2hfPLdVsoQl6Whn9fugdCGRl9KUllPYMyJuqJwSh9bzQTsJ_VO7A3kEna13P3VOP5G3skq-XfWn3PWdmNy90HeiDikAbV4RTaxGx6OLlV6s7swqT--lQUhn8NjRYElkPBkhOKtdt_sTGXDfEcvuCB2ymvRjLxHjSB3W0o0MThiizKevEhOuwo4z6su2EECmoQ_ahGVo-f64qgSYGflflYAWtvwLntjEa1uJQ8oCbSJaffk34VHenTLj4bc-rCfbGjXK4azw_HxTm7l8em-hxpoGEm_QzNMar0NGY5hn2nZove6ekDLHUp5DpcwuAhN2nbuswRjCeI3i4f2e8EUa4w_PNHvlMk5vBTErMqNTA-28pyfz5OD1MyEQ7fH5vSnsLvRWvpYFTl-1J22krPTurN_TxPGBaEEyHSJHdK_5rqBE4kwJBwDWY-tPJrRJKKQaRF7AtvtYBhiRFlcU1eX5tWiSJvVKK5jwCLpd8nq58cx1xo5bWDspidNbAWDAh_xTQ6YFQcBX4gVDUPtse-tOBiXFjX-7O7EL3ykkWDlybRUgOw__HcemaneydY1fytJBcK_AUbB46pO0aNct11cP2-S92ie-HTwibymWuoU-YhLDEid4\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"transcription\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\",\n \"transcription_data\": [\n {\n \"words\": [\n {\n \"word\": \"Hello,\",\n \"end_time\": 1.1,\n \"start_time\": 0.8\n },\n {\n \"word\": \"John.\",\n \"end_time\": 1.5,\n \"start_time\": 1.1\n },\n {\n \"word\": \"Thank\",\n \"end_time\": 1.7,\n \"start_time\": 1.5\n },\n {\n \"word\": \"you\",\n \"end_time\": 1.8,\n \"start_time\": 1.7\n },\n {\n \"word\": \"so\",\n \"end_time\": 1.9,\n \"start_time\": 1.8\n },\n {\n \"word\": \"much\",\n \"end_time\": 2.1,\n \"start_time\": 1.9\n },\n {\n \"word\": \"for\",\n \"end_time\": 2.3,\n \"start_time\": 2.1\n },\n {\n \"word\": \"your\",\n \"end_time\": 2.4,\n \"start_time\": 2.3\n },\n {\n \"word\": \"response.\",\n \"end_time\": 3.1,\n \"start_time\": 2.4\n },\n {\n \"word\": \"Can\",\n \"end_time\": 4,\n \"start_time\": 3.9\n },\n {\n \"word\": \"you\",\n \"end_time\": 4.1,\n \"start_time\": 4\n },\n {\n \"word\": \"please\",\n \"end_time\": 4.8,\n \"start_time\": 4.1\n },\n {\n \"word\": \"explain\",\n \"end_time\": 5.3,\n \"start_time\": 4.8\n },\n {\n \"word\": \"have\",\n \"end_time\": 5.5,\n \"start_time\": 5.3\n },\n {\n \"word\": \"it\",\n \"end_time\": 5.6,\n \"start_time\": 5.5\n },\n {\n \"word\": \"better?\",\n \"end_time\": 6.1,\n \"start_time\": 5.6\n },\n {\n \"word\": \"Why\",\n \"end_time\": 6.3,\n \"start_time\": 6.1\n },\n {\n \"word\": \"do\",\n \"end_time\": 6.4,\n \"start_time\": 6.3\n },\n {\n \"word\": \"you\",\n \"end_time\": 6.5,\n \"start_time\": 6.4\n },\n {\n \"word\": \"love\",\n \"end_time\": 6.7,\n \"start_time\": 6.5\n },\n {\n \"word\": \"strawberries?\",\n \"end_time\": 7.5,\n \"start_time\": 6.7\n },\n {\n \"word\": \"Thank\",\n \"end_time\": 8.2,\n \"start_time\": 8\n },\n {\n \"word\": \"you.\",\n \"end_time\": 8.5,\n \"start_time\": 8.2\n }\n ],\n \"confidence\": 0.90139115,\n \"transcript\": \"Hello, John. Thank you so much for your response. Can you please explain have it better? Why do you love strawberries? Thank you.\"\n }\n ],\n \"type\": \"video\"\n },\n {\n \"author_type\": \"contact\",\n \"created_at\": \"2020-08-13T09:32:21.909981Z\",\n \"is_public\": false,\n \"media_type\": \"text\",\n \"message_id\": \"511bfc20-691e-471f-9f73-02e1d9888b41\",\n \"share_id\": \"mqre28jqxifto11ejkxhvln4c3akaks8ejciqlk1\",\n \"share_url\": \"https://www.videoask.com/mqre28jqxifto11ejkxhvln4c3akaks8ejciqlk1\",\n \"thread_id\": \"95ae6155-f970-4d18-9116-191777fef28a\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"Because they look good, they smell good and they taste good! \\nThey're even a great source of nutrition and antioxidants.\",\n \"type\": \"text\",\n \"input_text\": \"Because they look good, they smell good and they taste good! \\nThey're even a great source of nutrition and antioxidants.\"\n }\n ],\n \"platform\": \"desktop\",\n \"tags\": [],\n \"are_answers_public\": false,\n \"are_messages_public\": false,\n \"share_id\": \"c3rqviz79cva7xmuoo70rva4l5fi699isbzvxjym\",\n \"share_url\": \"https://www.videoask.com/c3rqviz79cva7xmuoo70rva4l5fi699isbzvxjym\"\n },\n \"form\": {\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"title\": \"Example form for documentation\",\n \"requires_contact_info\": true,\n \"requires_contact_email\": true,\n \"requires_contact_name\": true,\n \"requires_contact_phone_number\": false,\n \"hide_branding\": false,\n \"metadata\": {\n \"primary_color\": \"#522CBB\",\n \"secondary_color\": \"#4CD982\",\n \"locale\": \"en-US\",\n \"show_form_title\": true\n },\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"created_at\": \"2020-03-30T15:53:59.331687Z\",\n \"updated_at\": \"2020-04-23T08:40:51.775168Z\",\n \"respondents_count\": 13,\n \"author_id\": \"8a484e48-2e8e-423d-8d91-b1d6c98b60f2\",\n \"questions\": [\n {\n \"answers_count\": 9,\n \"created_at\": \"2020-03-30T15:53:59.697150Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"media_id\": \"e627bdd1-a9db-41a9-80db-a6546c9c6ba6\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy.mp4?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy.mp4\",\n \"metadata\": {\n \"text\": \"What's your favorite fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"poll_options\": [\n {\n \"id\": \"27b7cd85-db1e-4316-8dbe-772523feb098\",\n \"content\": \"Bananas\",\n \"total_count\": 3\n },\n {\n \"id\": \"38ee39f0-aca3-4f3a-a74b-ec65beb139b3\",\n \"content\": \"Strawberries\",\n \"total_count\": 4\n },\n {\n \"id\": \"b15efc9c-ae2e-4254-b653-50c8ef2b7364\",\n \"content\": \"Apples\",\n \"total_count\": 0\n },\n {\n \"id\": \"3c4a9c2e-fab0-47bf-b545-ff2d77ce3b21\",\n \"content\": \"Grapes\",\n \"total_count\": 1\n },\n {\n \"id\": \"6daada9f-cc7b-4ffe-9529-f16f35517770\",\n \"content\": \"Other\",\n \"total_count\": 1\n }\n ],\n \"allow_multiple_selection\": false,\n \"question_id\": \"4d73e927-e0ef-4b73-a5da-cdda038545e1\",\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"thumbnail\": \"https://media3.giphy.com/media/xUPGcuomRFMUcsB9nO/giphy-preview.gif?cid=c83daf2546ecd961cfc590162cdb4787bf1c482527149606&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"poll\",\n \"updated_at\": \"2020-03-30T15:57:11.319072Z\"\n },\n {\n \"allowed_answer_media_types\": [\n \"video\",\n \"audio\",\n \"text\"\n ],\n \"created_at\": \"2020-03-30T15:57:10.931514Z\",\n \"form_id\": \"5a1b8066-f92c-47bf-b8f2-3beb0a738122\",\n \"media_id\": \"8031b331-c5e1-4fda-8523-314c2fa5cdd8\",\n \"media_type\": \"video\",\n \"media_url\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy.mp4?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy.mp4\",\n \"metadata\": {\n \"text\": \"Why do you love that fruit?\",\n \"darken_text_background\": true,\n \"fit_video\": false\n },\n \"allow_multiple_selection\": false,\n \"question_id\": \"a74ac70a-b207-492d-a3c8-43c8508f5c7a\",\n \"share_id\": \"f72l3mugt\",\n \"share_url\": \"https://www.videoask.com/f72l3mugt\",\n \"thumbnail\": \"https://media2.giphy.com/media/9nIIo3LBIlzvW/giphy-preview.gif?cid=c83daf25eacd7951d2151b3805a0177237e0b1c9c45d0b31&rid=giphy-preview.gif\",\n \"transcode_status\": \"completed\",\n \"transcribe_status\": \"completed\",\n \"type\": \"standard\",\n \"updated_at\": \"2020-03-30T15:57:11.324552Z\"\n }\n ],\n \"are_answers_public\": false,\n \"notifications\": {\n \"send_contact_message_emails\": true\n }\n },\n \"message\": {\n \"author_type\": \"contact\",\n \"created_at\": \"2020-08-13T09:32:21.909981Z\",\n \"is_public\": false,\n \"media_type\": \"text\",\n \"message_id\": \"511bfc20-691e-471f-9f73-02e1d9888b41\",\n \"share_id\": \"mqre28jqxifto11ejkxhvln4c3akaks8ejciqlk1\",\n \"share_url\": \"https://www.videoask.com/mqre28jqxifto11ejkxhvln4c3akaks8ejciqlk1\",\n \"thread_id\": \"95ae6155-f970-4d18-9116-191777fef28a\",\n \"transcode_status\": \"completed\",\n \"transcription\": \"Because they look good, they smell good and they taste good! \\nThey're even a great source of nutrition and antioxidants.\",\n \"type\": \"text\",\n \"input_text\": \"Because they look good, they smell good and they taste good! \\nThey're even a great source of nutrition and antioxidants.\"\n }\n}\nRetrieves a list of JSON descriptions for all brandings in your VideoAsk account. Brandings are sorted by creation date in descending order.
\nFields for pagination:
\noffset: to indicate from which answer we want to start the pagelimit: to indicate the size of the pageRetrieves a branding by the given branding_id
To retrieve your image_id, refer to the two \"Upload brand logo\" endpoints below.
To upload your brand logo or favicon and retrieve its image_id, you need to make two requests.
This first request will generate a response that includes the presigned_post_params, which contains the URL where you will upload your image in the second step.
⚠️ 5MB is the max file size for the brand logo or favicon.
\n","urlObject":{"path":["images"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"3dacf77c-720d-4422-815e-dd0c5344f774","name":"(1/2) Upload brand logo","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"extension\":\"image/png\"\n}"},"url":"https://api.videoask.com/images"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"image_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"organization_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n\t\"extension\": \"png\",\n\t\"media_url\": \"https://media.videoask.com/images/raw/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/image.png?token=xxxxxxxxxx\",\n\t\"presigned_url\": \"https://videoask-uploads-prod.s3.amazonaws.com/images/raw/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/image.png?AWSAccessKeyId=xxxxxxxxxx&Signature=xxxxxxxxxx&content-type=image%2Fpng&x-amz-security-token=xxxxxxxxxx&Expires=1667505108\",\n\t\"presigned_post_params\": {\n\t\t\"url\": \"https://videoask-uploads-prod.s3.amazonaws.com/\",\n\t\t\"fields\": {\n\t\t\t\"content-type\": \"image/png\",\n\t\t\t\"key\": \"images/raw/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/image.png\",\n\t\t\t\"AWSAccessKeyId\": \"xxxxxxxxxx\",\n\t\t\t\"x-amz-security-token\": \"xxxxxxxxxx\",\n\t\t\t\"policy\": \"xxxxxxxxxx\",\n\t\t\t\"signature\": \"xxxxxxxxxx\"\n\t\t}\n\t},\n\t\"author_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n}"}],"_postman_id":"010a2558-f002-4695-9647-dd3c6aace1e7"},{"name":"(2/2) Upload brand logo or favicon","id":"0a8da63d-9f6f-4d0a-9423-958a7d195614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"https://videoask-uploads-prod.s3.amazonaws.com/","description":"In this second request, you upload the binary contents of your image to the presigned_post_params URL from the previous request.
In Python, for example, you can read the binary contents of your image and upload it to the URL using the following code snippet:
\nimage_path = \"/Users/andrew/Downloads/my_logo.png\"\n\nwith open(image_path, 'rb') as f:\n files = {'file': (image_path, f)}\n response = requests.request(\"POST\", \"https://videoask-uploads-prod.s3.amazonaws.com/\", data=json_response['presigned_post_params']['fields'], files=files)\n\nAfter uploading your brand logo or favicon, you can use the image_id from the first request when creating a brand in VideoAsk.
⚠️ 5MB is the max file size for the brand logo or favicon.
\n","urlObject":{"protocol":"https","path":[""],"host":["videoask-uploads-prod","s3","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a8da63d-9f6f-4d0a-9423-958a7d195614"},{"name":"Update a brand","id":"ace23c09-686d-4309-a7e6-eefeb71e4085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Authorization","value":"Bearer token","type":"text"},{"key":"Content-Type","value":"application/json"},{"key":"organization-id","value":"{{organization_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My brand's name\",\n \"branding_url\": \"https://brand.com\",\n \"logo\": \"{{image_id}}\"\n \"custom_domain\": \"https://ask.brand.com\",\n}"},"url":"https://api.videoask.com/brandings/{{branding_id}}","urlObject":{"path":["brandings","{{branding_id}}"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ace23c09-686d-4309-a7e6-eefeb71e4085"}],"id":"1c89e109-d4d3-4397-97a4-8f4e4904ea93","description":"The Brandings API lets you give a customized feeling to the videoasks in your account.
\nYou can create or modify one or more brandings for your videoasks to use.
\nWith a branding you can set a custom logo and url in your videoasks, or set a white label domain from where to serve your videoasks and where the brand's customers will be able to answer back.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"9a918377-cea3-445c-a38a-c344a550e2d8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3fe9b58-36c9-4bfe-9dd1-16d55feccf9b","type":"text/javascript","exec":[""]}}],"_postman_id":"1c89e109-d4d3-4397-97a4-8f4e4904ea93"},{"name":"Account","item":[{"name":"Retrieve your own account","id":"3d15c76f-2494-4a75-a55c-7edc2f185738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"url":"https://api.videoask.com/me","description":"Retrieve your own account information.
\n","urlObject":{"path":["me"],"host":["https://api.videoask.com"],"query":[],"variable":[]}},"response":[{"id":"52b2b041-20bd-499e-99a0-f66315442a12","name":"Get your own account","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.videoask.com/me?Authorization=Bearer token","host":["https://api.videoask.com"],"path":["me"],"query":[{"key":"Authorization","value":"Bearer token","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 24 Feb 2020 17:01:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"293"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.2"},{"key":"Allow","value":"GET, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Cookie, Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"username\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"terms_and_conditions\": true,\n \"marketing_communications_opt_in\": true,\n \"tailored_experience_opt_in\": true,\n \"third_parties_data_opt_in\": true,\n \"created_at\": \"2019-05-01T08:25:21.820570Z\"\n}"}],"_postman_id":"3d15c76f-2494-4a75-a55c-7edc2f185738"}],"id":"86582700-a1fb-4539-a0fd-effa26c46518","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"89f503ee-b8e1-4a1a-8b3d-61792738495f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7861343d-a286-4d0a-97bc-5a51f8f30cb4","type":"text/javascript","exec":[""]}}],"_postman_id":"86582700-a1fb-4539-a0fd-effa26c46518","description":""}],"event":[{"listen":"prerequest","script":{"id":"ef217ef4-6e40-46f0-b174-5572da6e35db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8578d090-34e5-45a0-9e5e-9e1d42210222","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.videoask.com"},{"key":"form_id","value":"form_id"},{"key":"question_id","value":"question_id"},{"key":"auth_url","value":"https://"},{"key":"organization-id","value":"organization-id"},{"key":"token","value":"token"},{"key":"respondent_id","value":"respondent_id"},{"key":"soft_delete","value":"true"}]}