{"info":{"_postman_id":"bf903a19-0b74-4537-a863-6dc3131510c2","name":"Willo Integration API V2","description":"

Welcome to the Willo API documentation

Authentication

The Willo API uses API keys to authenticate requests - you can view and manage your API keys on your Willo Integrations page.

Each user has their own API key. This API key carries the same permissions as this user and will dictate the permissions of any requests made using this API key.

Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code etc.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Cycle your API key at any time - important if you think someone else has obtained it without your permission. Issue new key.

Rate Limits

Willo has API throttling to allow more consistent performance within a time span for customers calling our APIs. Throttling limits the number of requests to a service in a time span to prevent the overuse of resources. While Willo is designed to handle a very high volume of requests, if an overwhelming number of requests occur by few customers, throttling helps maintain optimal performance and reliability for all customers and candidates.

Best practice to avoid rate limiting

Programming practices such as continuously polling an endpoint to check for updates and regularly scanning jobs to check for new or deleted responses are more likely to lead to throttling and will degrade overall performance. Concurrent API calls may lead to high number of requests per unit time, which will also cause requests to be throttled. You should instead use webhooks for change tracking and change notifications.

If you are regularly hitting your limit with higher volume demands, please contact us to discuss an increased rate limit.

Data Privacy and Security

Businesses that use Willo can be confident that the company takes security seriously and employs best practices to ensure that privacy and security are not compromised.

The nature of the data that Willo handles on behalf of its customers requires that security is a core part of the approach to building, scaling, and managing the service.

Highlights

Our AWS hosted data centres are ISO/IEC 27001:2013 certified
\n
Encryption In-Transit (TLS 1.2)
\n
Encryption At-Rest (AES-256)
\n
Web Application Firewall (WAF)
\n
Distributed Denial of Service (DDoS) Protection
\n
Regular Vulnerability Scanning
\n
24/7 Monitoring and Incident Response
\n
GDPR Compliance
\n
ISMS Certified to ISO 27001:2022
\n
WCAG 2.1 AA aligned
\n

Changelog and System Status

We work hard to keep our developer community updated with the latest changes and enhancements to the platform.

View our weekly changelog here.

Subscribe to our system status here.

Developer Support

Save time and hassle - schedule premium 1-to-1 time with an expert in our integrations team and we'll help you go live asap. Book developer support now.

Status Codes

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

Status Code	Description
200 - OK	Everything worked as expected.
201 - Created	The object in the request was successfully created.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorised	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.
429 - Too Many Requests	The client has sent too many requests in a given time frame

Glossary

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

Term	Description
Department	A department is a sub-division of the account. Typically, departments are used to represent divisions of a business (eg brand, geography etc). Each department can be configured to have different branding via API or using the UI. Users must be granted permissions to view departments unless they are set to 'Global' in which case all users will have access to this department by default.
Interview	An interview contains a list of pre-defined questions that the participant must answer. In the use case of recruitment, 'interviews' typically correspond to 'jobs' within an ATS.
Message Template (Template)	Message Templates are used to manage the email and SMS communication that is sent to Participants from Willo. Each type of Message Template has a system default. Additional Message Templates can be added and customized. Once added, Message Templates can be configured to be used for Interviews. When inviting a Participant to participate in an Interview, Message Templates can be configured to be On or Off. There are 3 types of Message Template: 1. Invite (Email & SMS) - this is triggered when a Participant is invited to participate in an Interview. SMS will only be triggered if a valid phone number is provided. 2. Reminder (Email & SMS) - this is triggered in the event that a Participant has not completed their Interview within 48 & 72 hours of receiving an invitation. SMS will only be triggered if a valid E.164 formatted phone number is provided. 3. Success Email (Email only) - this is a transactional email sent to the Participant to confirm once they have successfully completed their interview. It is useful to avoid candidates reaching out to query if their interview has been recevied.
Participant	A Participant is a user who participates in an Interview. Refered to as a 'candidate' in recruitment use cases. Participants are not required to download, log in or authenticate to complete an interview. All major browsers and devices are supported.
Users	Users are authenticated users with access to Interviews and Participants. There are Three roles: 1. Owner - this is the account owner with the highest level of access. By default they will receive invoices and receipts. 2. Admin - this is the highest level of permissions that can be granted to a user who is not the account owner. Admins have permission to Create, Read, Update & Delete ALL Departments, Interviews and Participants. 3. Standard - this is the lowest level of permissions. Standard users only have permission to Create, Read, Update & Delete Departments, Interviews and Participants that belong to their account by default. Standard users can be invited by other users to view other Interviews.
Webhooks	Webhooks can be configured to trigger notifications to a 3rd party system's endpoints. There are four types of triggers: 1. New Response - when a new Interview response is received by a Participant. 2. Stage Change - when a Participant is moved to a different stage within the Willo Kanban board. 3. New Comment - when a Participant receives a comment from any member of hiring team 4. New Score - when a Participant receives a score from a member of the hiring team.
Child Organisation	An organisation created under a parent organisation. Child organisations operate within the parent’s umbrella and inherit its properties, but can be managed independently.

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Welcome to the Willo API documentation","slug":"welcome-to-the-willo-api-documentation"}],"owner":"7798010","collectionId":"bf903a19-0b74-4537-a863-6dc3131510c2","publishedId":"VUjSEiSn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-11-24T11:52:45.000Z"},"item":[{"name":"Departments","item":[{"name":"List Departments","id":"f623b7ea-39b2-461b-8f07-e22657c911e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/departments/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
search	String	Search by department name, owner email	Optional
owner	String	Key of the owner	Optional
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	name -name created_at -created_at

","urlObject":{"path":["departments",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ea463f07-696f-4378-b04c-b11469867a32","name":"List Departments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/departments/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 12,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"d257d49e5fd243f2b8ed7a0f84db6948\",\n \"name\": \"Willo\",\n \"owner\": {\n \"key\": \"da636340df4a4ae89d2d752ea1cc4699\",\n \"email\": \"john.doe@willo.video\",\n \"full_name\": \"John Doe\"\n }\n }\n ]\n}"}],"_postman_id":"f623b7ea-39b2-461b-8f07-e22657c911e9"},{"name":"Create Department","id":"07f6eb85-dc10-4be9-9e7c-08ed7af7f939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/departments/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
name	String	Title of the department	Required
industry	String	Key of the industry	Optional
location	String	Location of the department	Optional
website	String	URL of the website	Optional
primary_colour	String	Colour of header and footer	Optional
secondary_colour	String	Colour of buttons	Optional
logo	File	Logo of the department	Optional
is_default	Boolean	Directive the mark the department as default for the organisation	Optional	true/false
is_global	Boolean	Directive the mark the department as global and visible for all organisation members	Optional	true/false

","urlObject":{"path":["departments",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5846e6a7-bb30-4517-9150-db40454e0b44","name":"Create Department","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"industry","value":"28bdabb97b1b4553abce5d0f4dc8bc2f","type":"text"},{"key":"name","value":"Willo","type":"text"},{"key":"location","value":"Glasgow","type":"text"},{"key":"website","value":"https://willo.video","type":"text"},{"key":"primary_colour","value":"#2f3312","type":"text"},{"key":"secondary_colour","value":"#3f4425","type":"text"},{"key":"logo","type":"file","value":null},{"key":"is_default","value":"false","type":"text"},{"key":"is_global","value":"false","type":"text"}]},"url":"{{base_url}}/departments/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"de3b5651d1f24ec9afeb8787e0e3be7a\",\n \"name\": \"Willo\",\n \"location\": \"Glasgow\",\n \"primary_colour\": \"#2f3312\",\n \"secondary_colour\": \"#3f4425\",\n \"logo\": \"https://logo.png\",\n \"website\": \"https://willo.video\",\n \"industry\": {\n \"key\": \"28bdabb97b1b4553abce5d0f4dc8bc2f\",\n \"name\": \"IT\"\n },\n \"is_default\": false,\n \"is_global\": false\n}"}],"_postman_id":"07f6eb85-dc10-4be9-9e7c-08ed7af7f939"},{"name":"Department Details","id":"72fe45ed-e251-428b-b69b-41b66b1a9c33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/departments//","urlObject":{"path":["departments","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ad6b2201-488f-430b-8aa1-e195aef49193","name":"Department Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/departments//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"de3b5651d1f24ec9afeb8787e0e3be7a\",\n \"name\": \"Willo\",\n \"location\": \"Glasgow\",\n \"primary_colour\": \"#2f3312\",\n \"secondary_colour\": \"#3f4425\",\n \"logo\": \"https://logo.png\",\n \"website\": \"https://willo.video\",\n \"industry\": {\n \"key\": \"28bdabb97b1b4553abce5d0f4dc8bc2f\",\n \"name\": \"IT\"\n },\n \"is_default\": false,\n \"is_global\": false\n}"}],"_postman_id":"72fe45ed-e251-428b-b69b-41b66b1a9c33"},{"name":"Update Department (PUT)","id":"019cb30d-1e79-43e2-be7a-78d87b3263cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/departments//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
name	String	Title of the department	Required
industry	String	Key of the industry	Optional
location	String	Location of the department	Optional
website	String	URL of the website	Optional
primary_colour	String	Colour of header and footer	Optional
secondary_colour	String	Colour of buttons	Optional
logo	File	Logo of the department	Optional
is_default	Boolean	Directive the mark the department as default for the organisation	Optional	true/false
is_global	Boolean	Directive the mark the department as global and visible for all organisation members	Optional	true/false

","urlObject":{"path":["departments","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6d8385c-cc0a-438e-810f-f7ae879b1015","name":"Update Department (PUT)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"industry","value":"28bdabb97b1b4553abce5d0f4dc8bc2f","type":"text"},{"key":"name","value":"Willo","type":"text"},{"key":"location","value":"Glasgow","type":"text"},{"key":"website","value":"https://willo.video","type":"text"},{"key":"primary_colour","value":"#2f3312","type":"text"},{"key":"secondary_colour","value":"#3f4425","type":"text"},{"key":"logo","type":"file","value":null},{"key":"is_default","value":"false","type":"text"},{"key":"is_global","value":"false","type":"text"}]},"url":"{{base_url}}/departments//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"de3b5651d1f24ec9afeb8787e0e3be7a\",\n \"name\": \"Willo\",\n \"location\": \"Glasgow\",\n \"primary_colour\": \"#2f3312\",\n \"secondary_colour\": \"#3f4425\",\n \"logo\": \"https://logo.png\",\n \"website\": \"https://willo.video\",\n \"industry\": {\n \"key\": \"28bdabb97b1b4553abce5d0f4dc8bc2f\",\n \"name\": \"IT\"\n },\n \"is_default\": false,\n \"is_global\": false\n}"}],"_postman_id":"019cb30d-1e79-43e2-be7a-78d87b3263cb"},{"name":"Update Department (PATCH)","id":"ac61a1de-a94f-45a1-ada8-d1e9e304e5e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{base_url}}/departments//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
name	String	Title of the department	Required
industry	String	Key of the industry	Optional
location	String	Location of the department	Optional
website	String	URL of the website	Optional
primary_colour	String	Colour of header and footer	Optional
secondary_colour	String	Colour of buttons	Optional
logo	File	Logo of the department	Optional
is_default	Boolean	Directive the mark the department as default for the organisation	Optional	true/false
is_global	Boolean	Directive the mark the department as global and visible for all organisation members	Optional	true/false

","urlObject":{"path":["departments","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"14ebf9cd-113b-4d77-91ac-d1ae07369c93","name":"Update Department (PATCH)","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"industry","value":"28bdabb97b1b4553abce5d0f4dc8bc2f","type":"text"},{"key":"name","value":"Willo","type":"text"},{"key":"location","value":"Glasgow","type":"text"},{"key":"website","value":"https://willo.video","type":"text"},{"key":"primary_colour","value":"#2f3312","type":"text"},{"key":"secondary_colour","value":"#3f4425","type":"text"},{"key":"logo","type":"file","value":null},{"key":"is_default","value":"false","type":"text"},{"key":"is_global","value":"false","type":"text"}]},"url":"{{base_url}}/departments//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"de3b5651d1f24ec9afeb8787e0e3be7a\",\n \"name\": \"Willo\",\n \"location\": \"Glasgow\",\n \"primary_colour\": \"#2f3312\",\n \"secondary_colour\": \"#3f4425\",\n \"logo\": \"https://logo.png\",\n \"website\": \"https://willo.video\",\n \"industry\": {\n \"key\": \"28bdabb97b1b4553abce5d0f4dc8bc2f\",\n \"name\": \"IT\"\n },\n \"is_default\": false,\n \"is_global\": false\n}"}],"_postman_id":"ac61a1de-a94f-45a1-ada8-d1e9e304e5e4"},{"name":"Delete Department","id":"0537fa2e-6e9b-4c50-86bf-f961b2e2a0c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/departments//","urlObject":{"path":["departments","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7593e12f-79f1-457e-b6ce-00c17ceb5d1b","name":"Delete Department","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/departments//"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0537fa2e-6e9b-4c50-86bf-f961b2e2a0c6"}],"id":"8d68319d-2986-4e49-8640-224674b94d80","_postman_id":"8d68319d-2986-4e49-8640-224674b94d80","description":""},{"name":"IDV Countries of Employment","item":[{"name":"List Countries","id":"e7361f1b-0839-4b43-a8bb-2430bf7ed13c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Connect section of Willo

\n","type":"text"}],"url":"{{base_url}}/idv-counties/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	iso_3 -iso_3

","urlObject":{"path":["idv-counties",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"250edd2e-87dc-4d0f-a2f8-6122978a191b","name":"List Countries","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Integrations page of Willo","type":"text"}],"url":"{{base_url}}/idv-counties/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 250,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"name\": \"United Kingdom\",\n \"iso_3\": \"GBR\"\n }\n ]\n}"}],"_postman_id":"e7361f1b-0839-4b43-a8bb-2430bf7ed13c"}],"id":"1a240ebd-2ffa-4855-b212-c37b98bb35b8","_postman_id":"1a240ebd-2ffa-4855-b212-c37b98bb35b8","description":""},{"name":"Interviews","item":[{"name":"List Interviews","id":"3e17cb89-19c1-47e2-85bf-3e6b71e9e3c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{api_key}}","type":"text","description":"

Integration key available in Integrations page of Willo

\n"}],"url":"{{base_url}}/interviews/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
department	String	Key of the department	Optional
owner	String	Key of the owner	Optional
search	String	Search by title, owner email, department name	Optional
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	title (default) -title created_at -created_at

","urlObject":{"path":["interviews",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"65043c12-11da-4901-aa28-def0addd4a86","name":"List Interviews","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base_url}}/api/integrations/v2/interviews/?department&owner&search&ordering&page_size","host":["{{base_url}}"],"path":["api","integrations","v2","interviews",""],"query":[{"key":"department","value":null,"description":"key of the department"},{"key":"owner","value":null,"description":"key of the interview owner"},{"key":"search","value":null,"description":"query text"},{"key":"ordering","value":null,"description":"order by field"},{"key":"page_size","value":null,"description":"amount of items per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"1e2048a686804049b128f1357c559cbf\",\n \"title\": \"Researcher\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\"\n }\n ]\n}"}],"_postman_id":"3e17cb89-19c1-47e2-85bf-3e6b71e9e3c0"},{"name":"Create Interview","id":"9636fa80-fadd-4460-a914-a38338d96d72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interviews/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
title	String	Title of the interview	Required
default_language	String	The language that the interview should be displayed in by defaultt	Optional	'en', 'zh', 'hi', 'es', 'fr', 'ar', 'ru', 'id', 'de', 'nl', 'el', 'zhtw', 'cy', 'ua', 'it', 'ko', 'ja', 'ht'
department	String	Key of the department	Required
salary	String	Salary	Optional
description	String	Description of the interview	Optional
message_templates[invitation_email]	String, null	Key of the Email invite template or null to use a default one	Required	null, message_key
message_templates[invitation_sms]	String, null	Key of the SMS invite template or null to use a default one	Required	null, message_key
message_templates[reminder_email]	String, null	Key of the Email reminder template or null to use a default one	Required	null, message_key
message_templates[reminder_sms]	String, null	Key of the SMS reminder template or null to use a default one	Required	null, message_key
message_templates[interview_completed_email]	String, null	Key of the Email success template or null to use a default one	Required	null, message_key
intro_video	String	Url of the introduction video	Optional
reviewers	List[String]	List of keys of users who can access the interview	Optional
reviewers_to_notify	List[String]	List of keys of users who will be notified about the new response	Optional
questions[text]	String	Text of the question	Required
question[order]	Integer	Order number of the question	Required
question[max_duration]	Integer	Maximum duration of the answer (video, audio)	Optional
question[max_retakes]	Integer	Maximum amount of retakes participant can answer one question	Optional
question[answer_type]	String	Type of the answer	Required	video, audio, file, text, multiple_choice, checkboxes, idv, rtw, dbs, dbs_rtw
question[max_characters]	Integer	Maximum amount of characters in answer (For the \"text\" answer type)	Optional
question[max_words]	Integer	Maximum amount of words in answer (For the \"text\" answer type)	Optional
questions[thinking_time]	Integer	Recommended total time to answer question (For \"video\", \"audio\" & \"text\" answers)	Optional
questions[max_checks]	Integer	Number of IDV checks before usage alert	Optional
questions[location_of_employment]	String	3 characters country ISO code. Used to determine the type of digital identity check to be conducted	Required in case question[answer_type] is one of the following: idv, rtw, dbs, dbs_rtw
questions[type_specific_data]	Object	Data describing the configuration of specific question types (See table below)	Optional
settings[show_hints_and_tips]	Boolean	Directive to show the Hints & Tips page before the interview (default True)	Optional	true/false
settings[show_availability_calendar]	Boolean	Directive to ask participants about their availability following an interview (default True)	Optional	true/false
settings[redirect_url]	String, null	Url to redirect when the interview is complete	Optional
settings[deadline]	DateTime	DateTime when the interview will expire in ISO 8601 format (UTC)	Optional	YYYY-MM-DDTHH:MM:SS.ssssssZ

Question Type-specific data description:

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

Question Type	Description	Example
Multiple Choice (`multiple_choice`) / Checkboxes (`checkboxes`)	Describe options that are available to the candidate to select from. `text` - up to 256 characters string `is_correct`- optional boolean or null value that defines if the option is a correct answer to the question `order` - integer that defines the representation order of the option in the list	`\"answer_options\": [ { \"text\": \"Option 1\", \"is_correct\": true, \"order\": 1` `}, { \"text\": \"Option 2\", \"is_correct\": false, \"order\": 2 } ]` Also, watch \"Create Interview With Checkbox Type Question\" in the Request Example section

","urlObject":{"path":["interviews",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ac51db70-36c8-4e31-9757-584575cf8eda","name":"Create Interview","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"department\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"intro_video\": \"https://youtube.com/herefre-323/\",\n \"reviewers\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"reviewers_to_notify\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"questions\": [\n {\n \"text\": \"Tell me about yourself\",\n \"order\": 1,\n \"answer_type\": \"video\",\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"max_characters\": null,\n \"max_words\": null,\n \"thinking_time\": 300\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": \"2022-12-18T09:00:00.000000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/interviews/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"Can you describe a time when you successfully managed a customer complaint?\",\n \"html_text\": \"

Can you describe a time when you successfully managed a customer complaint?

\",\n \"order\": 0,\n \"max_duration\": 240,\n \"max_retakes\": null,\n \"answer_type\": \"video\",\n \"thinking_time\": null,\n \"max_characters\": null,\n \"max_words\": null,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {}\n },\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"What do you think is the most important skill for a Sales Assistant?\",\n \"html_text\": \"

What do you think is the most important skill for a Sales Assistant?

\",\n \"order\": 1,\n \"max_duration\": null,\n \"max_retakes\": null,\n \"answer_type\": \"multiple_choice\",\n \"thinking_time\": null,\n \"max_characters\": null,\n \"max_words\": null,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"d4c1e09ff6e548e78ffcc4388b5fa848\",\n \"text\": \"Communication\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"36e90d2760cf48d783a1daad0ae4e543\",\n \"text\": \"Teamwork\",\n \"order\": 2,\n \"is_correct\": false\n },\n {\n \"key\": \"d4c1e09ff6e548e78ffcc4388b5fa848\",\n \"text\": \"Product knowledge\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"36e90d2760cf48d783a1daad0ae4e543\",\n \"text\": \"Customer service\",\n \"order\": 2,\n \"is_correct\": true\n }\n ]\n }\n }\n ],\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": \"2022-12-18T09:00:00.000000Z\"\n }\n}"},{"id":"fb8cd30d-9bef-4e24-ba48-ff4a8c8735b8","name":"Create Interview With Checkbox Type Question","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Integration key available in Integrations page of Willo","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"department\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"intro_video\": \"https://youtube.com/herefre-323/\",\n \"reviewers\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"reviewers_to_notify\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"questions\": [\n {\n \"text\": \"What of the following skills to you have?\",\n \"order\": 1,\n \"answer_type\": \"checkboxes\",\n \"max_duration\": null,\n \"max_retakes\": null,\n \"max_characters\": null,\n \"max_words\": null,\n \"thinking_time\": 300,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"text\": \"Critical thinking\",\n \"is_correct\": null,\n \"order\": 1\n },\n {\n \"text\": \"Adaptability\",\n \"is_correct\": null,\n \"order\": 2\n },\n {\n \"text\": \"Time management\",\n \"is_correct\": null,\n \"order\": 3\n }\n ]\n }\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": \"2022-12-18T09:00:00.000000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/interviews/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"78d0380bb05f40fe9b5jdjfef3284d\",\n \"text\": \"What of the following skills to you have?\",\n \"order\": 1,\n \"max_duration\": null,\n \"max_retakes\": null,\n \"answer_type\": \"checkboxes\",\n \"thinking_time\": 300,\n \"max_characters\": null,\n \"max_words\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"0d8bcb748a68473434b283997259e333\",\n \"text\": \"Critical thinking\",\n \"is_correct\": null,\n \"order\": 1\n },\n {\n \"key\": \"4423b3e3bf424da3ac0b08bd534c933\",\n \"text\": \"Adaptability\",\n \"is_correct\": null,\n \"order\": 2\n },\n {\n \"key\": \"9987b3e3bf424da3ac0b08bd534m003\",\n \"text\": \"Time management\",\n \"is_correct\": null,\n \"order\": 3\n }\n ]\n }\n }\n ],\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": \"2022-12-18T09:00:00.000000Z\"\n }\n}"}],"_postman_id":"9636fa80-fadd-4460-a914-a38338d96d72"},{"name":"Interview Details","id":"42d6d5c0-8315-47aa-a759-ffcd7944a003","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interviews//","urlObject":{"path":["interviews","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b7b9b4dd-f18f-4776-a256-e8220ae2f0fd","name":"Retrieve Interview","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"Content-Type","value":"text/plain","type":"text"}],"url":"{{base_url}}/api/integrations/v2/interviews//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"email_invite_template\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"sms_invite_template\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"email_reminder_template\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"sms_reminder_template\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"email_success_template\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"Can you describe a time when you successfully managed a customer complaint?\",\n \"html_text\": \"

Can you describe a time when you successfully managed a customer complaint?

What do you think is the most important skill for a Sales Assistant?

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interviews//","description":"

Request body description

Key	Type	Description	Required	Restricted Values
title	String	Title of the interview	Required
default_language	String	The language that the interview should be displayed in by defaultt	Optional	'en', 'zh', 'hi', 'es', 'fr', 'ar', 'ru', 'id', 'de', 'nl', 'el', 'zhtw', 'cy', 'ua', 'it', 'ko', 'ja', 'ht'
department	String	Key of the department	Required
salary	String	Salary	Optional
description	String	Description of the interview	Optional
message_templates[invitation_email]	String, null	Key of the Email invite template or null to use a default one	Required	null, message_key
message_templates[invitation_sms]	String, null	Key of the SMS invite template or null to use a default one	Required	null, message_key
message_templates[reminder_email]	String, null	Key of the Email reminder template or null to use a default one	Required	null, message_key
message_templates[reminder_sms]	String, null	Key of the SMS reminder template or null to use a default one	Required	null, message_key
message_templates[interview_completed_email]	String, null	Key of the Email success template or null to use a default one	Required	null, message_key
intro_video	String	Url of the introduction video	Optional
reviewers	List[String]	List of keys of users who can access the interview	Optional
reviewers_to_notify	List[String]	List of keys of users who will be notified about the new response	Optional
questions[text]	String	Text of the question	Required
question[order]	Integer	Order number of the question	Required
question[max_duration]	Integer	Maximum duration of the answer (video, audio)	Optional
question[max_retakes]	Integer, null	Maximum amount of retakes participant can answer one question. Defaults to 10	Optional
question[answer_type]	String	Type of the answer	Required	video, audio, file, text, multiple_choice, checkboxes, idv, rtw, dbs, dbs_rtw
question[max_characters]	Integer	Maximum amount of characters in answer (For the \"text\" answer type)	Optional
question[max_words]	Integer	Maximum amount of words in answer (For the \"text\" answer type)	Optional
questions[thinking_time]	Integer	Recommended total time to answer question (For \"video\", \"audio\" & \"text\" answers)	Optional
questions[max_checks]	Integer	Number of IDV checks before usage alert	Optional
questions[location_of_employment]	String	3 characters country ISO code. Used to determine the type of digital identity check to be conducted	Required in case question[answer_type] is one of the following: idv, rtw, dbs, dbs_rtw
questions[type_specific_data]	Object	Data describing the configuration of specific question types (See table below)	Optional
settings[show_hints_and_tips]	Boolean	Directive to show the Hints & Tips page before the interview (default True)	Optional	true/false
settings[show_availability_calendar]	Boolean	Directive to ask participants about their availability following an interview (default True)	Optional	true/false
settings[redirect_url]	String, null	Url to redirect when the interview is complete	Optional
settings[deadline]	DateTime	DateTime when the interview will expire in ISO 8601 format (UTC)	Optional	YYYY-MM-DDTHH:MM:SS.ssssssZ

Question Type-specific data description:

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

Question Type	Description	Example
Multiple Choice (`multiple_choice`) / Checkboxes (`checkboxes`)	Describe options that are available to the candidate to select from. `key` - ID value of the specific option that needs to be provided, otherwise new option will be created `text` - up to 256 characters string `is_correct`- optional boolean or null value that defines if the option is a correct answer to the question `order` - integer that defines the representation order of the option in the list	`\"answer_options\": [ { \"key\": \"f334f343499fvdf8c3h334h3\", \"text\": \"Option 1\", \"is_correct\": true, \"order\": 1` `}, { \"key\": \"f334f343499fvdf8c3h3 \"text\": \"Option 2\", \"is_correct\": false, \"order\": 2 } ]` Also, watch \"Update Interview With Multiple Choice Type Question\" in the Request Example section

Please note**: once an interview has received responses, it is not possible to add/remove questions, or to change question types.

\n","urlObject":{"path":["interviews","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2e5f5a89-2c74-4cae-b0b4-65dc764c0c65","name":"Update Interview (PUT)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"department\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"intro_video\": \"https://youtube.com/herefre-323/\",\n \"reviewers\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"reviewers_to_notify\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"questions\": [\n {\n \"text\": \"Tell me about yourself\",\n \"order\": 1,\n \"answer_type\": \"video\",\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"max_characters\": null,\n \"max_words\": null,\n \"thinking_time\": 300\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/interviews//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"Can you describe a time when you successfully managed a customer complaint?\",\n \"html_text\": \"

Can you describe a time when you successfully managed a customer complaint?

What do you think is the most important skill for a Sales Assistant?

\",\n \"order\": 1,\n \"max_duration\": null,\n \"max_retakes\": null,\n \"answer_type\": \"multiple_choice\",\n \"thinking_time\": null,\n \"max_characters\": null,\n \"max_words\": null,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"d4c1e09ff6e548e78ffcc4388b5fa848\",\n \"text\": \"Communication\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"36e90d2760cf48d783a1daad0ae4e543\",\n \"text\": \"Teamwork\",\n \"order\": 2,\n \"is_correct\": false\n },\n {\n \"key\": \"d4c1e09ff6e548e78ffcc4388b5fa848\",\n \"text\": \"Product knowledge\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"36e90d2760cf48d783a1daad0ae4e543\",\n \"text\": \"Customer service\",\n \"order\": 2,\n \"is_correct\": true\n }\n ]\n }\n }\n ],\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": null\n }\n}"},{"id":"9c4cab28-8a25-4e72-84e5-ecab4e167b87","name":"Update Interview With Multiple Choice Type Question","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"department\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"intro_video\": \"https://youtube.com/herefre-323/\",\n \"reviewers\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"reviewers_to_notify\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"questions\": [\n {\n \"text\": \"Do you have a driver's licence?\",\n \"order\": 1,\n \"answer_type\": \"video\",\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"max_characters\": null,\n \"max_words\": null,\n \"thinking_time\": 300,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"99d0380bnhjf40fe9b5jdjfef32933\",\n \"text\": \"Yes\",\n \"is_correct\": true,\n \"order\": 1\n },\n {\n \"key\": \"57d0380bnhjf40hhkb5jdjfef32911\",\n \"text\": \"No\",\n \"is_correct\": false,\n \"order\": 2\n }\n ]\n }\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": null\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/interviews//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"78d0380bb05f40fe9b5jdjfef3284d\",\n \"text\": \"Tell me about yourself\",\n \"order\": 1,\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"answer_type\": \"video\",\n \"thinking_time\": 300,\n \"max_characters\": null,\n \"max_words\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"99d0380bnhjf40fe9b5jdjfef32933\",\n \"text\": \"Yes\",\n \"is_correct\": true,\n \"order\": 1\n },\n {\n \"key\": \"57d0380bnhjf40hhkb5jdjfef32911\",\n \"text\": \"No\",\n \"is_correct\": false,\n \"order\": 2\n }\n ]\n }\n }\n ],\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": null\n }\n}"}],"_postman_id":"cbb1aa54-847b-449c-a0a8-3ef355a78265"},{"name":"Update Interview (PATCH)","id":"f9dd98e6-ec94-4f4d-80dd-9cd8348f676d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/interviews//","description":"

Request body description

Key	Type	Description	Required	Restricted Values
title	String	Title of the interview	Required
default_language	String	The language that the interview should be displayed in by defaultt	Optional	'en', 'zh', 'hi', 'es', 'fr', 'ar', 'ru', 'id', 'de', 'nl', 'el', 'zhtw', 'cy', 'ua', 'it', 'ko', 'ja', 'ht'
department	String	Key of the department	Required
salary	String	Salary	Optional
description	String	Description of the interview	Optional
message_templates[invitation_email]	String, null	Key of the Email invite template	Required	null, message_key
message_templates[invitation_sms]	String, null	Key of the SMS invite template	Required	null, message_key
message_templates[reminder_email]	String, null	Key of the Email reminder template	Required	null, message_key
message_templates[reminder_sms]	String, null	Key of the SMS reminder template	Required	null, message_key
message_templates[interview_completed_email]	String, null	Key of the Email success template	Required	null, message_key
intro_video	String	Url of the introduction video	Optional
reviewers	List[String]	List of keys of users who can access the interview	Optional
reviewers_to_notify	List[String]	List of keys of users who will be notified about the new response	Optional
questions[text]	String	Text of the question	Required
question[order]	Integer	Order number of the question	Required
question[max_duration]	Integer	Maximum duration of the answer (video, audio)	Optional
question[max_retakes]	Integer	Maximum amount of retakes participant can answer one question	Optional
question[answer_type]	String	Type of the answer	Required	video, audio, file, text, multiple_choice, checkboxes, idv, rtw, dbs, dbs_rtw
question[max_characters]	Integer	Maximum amount of characters in answer (For the \"text\" answer type)	Optional
question[max_words]	Integer	Maximum amount of words in answer (For the \"text\" answer type)	Optional
questions[thinking_time]	Integer	Recommended total time to answer question (For \"video\", \"audio\" & \"text\" answers)	Optional
questions[max_checks]	Integer	Number of IDV checks before usage alert	Optional
questions[location_of_employment]	String	3 characters country ISO code. Used to determine the type of digital identity check to be conducted	Required in case question[answer_type] is one of the following: idv, rtw, dbs, dbs_rtw
questions[type_specific_data]	Object	Data describing the configuration of specific question types (See table below)	Optional
settings[show_hints_and_tips]	Boolean	Directive to show the Hints & Tips page before the interview (default True)	Optional	true/false
settings[show_availability_calendar]	Boolean	Directive to ask participants about their availability following an interview (default True)	Optional	true/false
settings[redirect_url]	String, null	Url to redirect when the interview is complete	Optional
settings[deadline]	DateTime	DateTime when the interview will expire in ISO 8601 format (UTC)	Optional	YYYY-MM-DDTHH:MM:SS.ssssssZ

Question Type-specific data description:

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

Question Type	Description	Example
Multiple Choice (`multiple_choice`) / Checkboxes (`checkboxes`)	Describe options that are available to the candidate to select from. `key` - ID value of the specific option that needs to be provided, otherwise new option will be created `text` - up to 256 characters string `is_correct`- optional boolean or null value that defines if the option is a correct answer to the question `order` - integer that defines the representation order of the option in the list	`\"answer_options\": [ { \"key\": \"f334f343499fvdf8c3h334h3\", \"text\": \"Option 1\", \"is_correct\": true, \"order\": 1` `}, { \"key\": \"f334f343499fvdf8c3h3 \"text\": \"Option 2\", \"is_correct\": false, \"order\": 2 } ]` Also, watch \"Update Interview With Multiple Choice Type Question\" in the Request Example section

Please note: once an interview has received responses, it is not possible to add/remove questions, or to change question types.

\n","urlObject":{"path":["interviews","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"434f6e41-00ec-4f82-9ecf-509d82e908b9","name":"Update Interview (PATCH)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"department\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"intro_video\": \"https://youtube.com/herefre-323/\",\n \"reviewers\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"reviewers_to_notify\": [\n \"8a2c357bda634e3fbfdeb2c9bea88181\"\n ],\n \"questions\": [\n {\n \"text\": \"Tell me about yourself\",\n \"order\": 1,\n \"answer_type\": \"video\",\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"max_characters\": null,\n \"max_words\": null,\n \"thinking_time\": 300\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"settings\": {\n \"redirect_url\": \"https://yoursite.com\",\n \"show_hints_and_tips\": true,\n \"show_availability_calendar\": true,\n \"deadline\": \"2022-12-18T09:00:00.000000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/interviews//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"e501b631e26249f2993ee05dfaa72b40\",\n \"title\": \"Researcher\",\n \"default_language\": \"en\",\n \"salary\": \"5000$\",\n \"description\": \"We are looking for you!\",\n \"invite_link\": \"https://willotalent.com/invite/fhf3v/\",\n \"intro_video\": \"https://www.youtube.com/watch?v=hKqfBsFAMgs\",\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"owner\": {\n \"key\": \"d62a87cd963f46a0b6d020947fd1dcf5\",\n \"email\": \"mariecurie@example.com\",\n \"full_name\": \"Marie Curie\"\n },\n \"organisation\": {\n \"key\": \"78d0380bb05f40fe9b5103437ef3284d\",\n \"name\": \"Willo\"\n },\n \"department\": {\n \"key\": \"b323b3e3bf424da3ac0b08bd534c91e2\",\n \"name\": \"HR\"\n },\n \"reviewers\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"reviewers_to_notify\": [\n {\n \"key\": \"0d8bcb748a684738b0b283997259ef83\",\n \"email\": \"williamhenrygates@gmail.com\",\n \"full_name\": \"Bill Gates\"\n }\n ],\n \"message_templates\": {\n \"invitation_email\": \"cdbd4d93a7e448539a3b553db6b01d6b\",\n \"invitation_sms\": \"40f105a6c93a471dbcee1b1e5169051a\",\n \"reminder_email\": \"ebc11bf4479a4fa29c2ce25839a8d7ec\",\n \"reminder_sms\": \"6360c3a0c80d4ad7a4561cb2737af0e8\",\n \"interview_completed_email\": \"0d8bcb748a684738b0b283997259ef83\"\n },\n \"questions\": [\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"Can you describe a time when you successfully managed a customer complaint?\",\n \"html_text\": \"

Can you describe a time when you successfully managed a customer complaint?

What do you think is the most important skill for a Sales Assistant?

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/languages/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	iso_code -iso_code

","urlObject":{"path":["languages",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"44ddbead-07b3-4cda-955d-3eaefd367edd","name":"List Languages","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/languages/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 12,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\"iso_code\": \"ar\"},\n {\"iso_code\": \"de\"},\n {\"iso_code\": \"el\"},\n {\"iso_code\": \"en\"},\n {\"iso_code\": \"es\"},\n {\"iso_code\": \"fr\"},\n {\"iso_code\": \"hi\"},\n {\"iso_code\": \"id\"},\n {\"iso_code\": \"nl\"},\n {\"iso_code\": \"ru\"},\n {\"iso_code\": \"zh\"},\n {\"iso_code\": \"zhtw\"}\n ]\n}"}],"_postman_id":"91982689-c8ef-41e4-8e45-72355c688c4c"}],"id":"07cfe022-dd15-4524-97fe-413c60078540","_postman_id":"07cfe022-dd15-4524-97fe-413c60078540","description":""},{"name":"Message Templates","item":[{"name":"List Templates","id":"4bfcf111-3fec-499f-b2e1-5f6745cc451d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/message-templates/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
search	String	Search by template title	Optional
type	String	Template type	Optional	emails, sms
trigger	String	Template trigger	Optional	invite, reminder, success_email
system_default	Boolean	Filter by Willo default templates	Optional	true/false
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	-created_at created_at title -title

","urlObject":{"path":["message-templates",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"91bbe9a8-355e-4edd-81ea-b97dfc7836fb","name":"List Templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/message-templates/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"f894c5589b58454c9c861753f4f24108\",\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"system_default\": false\n },\n {\n \"key\": \"079eb0cefef5466bb931710cde3d5817\",\n \"title\": \"Interview Reminder\",\n \"type\": \"sms\",\n \"trigger\": \"reminder\",\n \"system_default\": false\n },\n {\n \"key\": \"079eb0cefef5466bb931710cde3d5817\",\n \"title\": \"Interview Completed\",\n \"type\": \"email\",\n \"trigger\": \"success_email\",\n \"system_default\": true\n }\n ]\n}"}],"_postman_id":"4bfcf111-3fec-499f-b2e1-5f6745cc451d"},{"name":"Create Template","id":"a02942f2-4080-4b55-a306-6ffc972a1621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/message-templates/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
title	String	Title of the template	Required
type	String	Type of the template	Required	email, sms
trigger	String	When template should be used	Required	invite, reminder, success_email
content	String	Content of the template with variables	Required	{candidate_first_name}{candidate_last_name}{candidate_full_name}{deadline_date}{interview_name}{interview_owner_name}{company_name}{organisation_name}

","urlObject":{"path":["message-templates",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3c43d076-a15d-44fc-acef-d2c33e744ceb","name":"Create Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/message-templates/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"f894c5589b58454c9c861753f4f24108\",\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\",\n \"system_default\": false\n}"}],"_postman_id":"a02942f2-4080-4b55-a306-6ffc972a1621"},{"name":"Template Details","id":"08cc0e2e-49da-4a57-9834-134e4a13f756","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/message-templates//","urlObject":{"path":["message-templates","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8377058d-78f9-4e1b-885d-64476b4908a7","name":"Template Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/message-templates//"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"f894c5589b58454c9c861753f4f24108\",\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\",\n \"system_default\": false\n}"}],"_postman_id":"08cc0e2e-49da-4a57-9834-134e4a13f756"},{"name":"Update Message Template (PUT)","id":"dbddcf05-999f-4a18-bc70-7ebec6c2900f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/message-templates//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
title	String	Title of the template	Required
type	String	Type of the template	Required	email, sms
trigger	String	When template should be used	Required	invite, reminder, success_email
content	String	Content of the template with variables	Required	{candidate_first_name}{candidate_last_name}{candidate_full_name}{deadline_date}{interview_name}{interview_owner_name}{company_name}{organisation_name}

","urlObject":{"path":["message-templates","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"37d4feb9-bed7-4b4a-8bdf-45d6906122c1","name":"Update Message Template","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/message-templates//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"f894c5589b58454c9c861753f4f24108\",\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\",\n \"system_default\": false\n}"}],"_postman_id":"dbddcf05-999f-4a18-bc70-7ebec6c2900f"},{"name":"Update Message Template (PATCH)","id":"ec589047-3a0c-40fa-a6ac-4f0f321a9c7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/message-templates//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
title	String	Title of the template	Optional
type	String	Type of the template	Optional	email, sms
trigger	String	When template should be used	Optional	invite, reminder, success_email
content	String	Content of the template with variables	Optional	{candidate_first_name}{candidate_last_name}{candidate_full_name}{deadline_date}{interview_name}{interview_owner_name}{company_name}{organisation_name}

","urlObject":{"path":["message-templates","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6aeb07cc-25fe-4449-9583-6baac2189b06","name":"Update Message Template","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/message-templates//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"f894c5589b58454c9c861753f4f24108\",\n \"title\": \"Participant Invitation\",\n \"type\": \"email\",\n \"trigger\": \"invite\",\n \"content\": \"Hello {candidate_full_name}! Thanks for your interest in the {interview_name}, {company_name} position. I'd like to get to know you better with a short one-way video interview.\",\n \"system_default\": false\n}"}],"_postman_id":"ec589047-3a0c-40fa-a6ac-4f0f321a9c7b"},{"name":"Delete Message Template","id":"038f2eb2-f742-4473-b980-135c989295f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/message-templates//","urlObject":{"path":["message-templates","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47968873-fe82-490d-9a03-66b7ab532a31","name":"Delete Message Template","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"}],"url":"{{base_url}}/message-templates//"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"038f2eb2-f742-4473-b980-135c989295f9"}],"id":"528b0176-898a-4c30-bde9-87ebce0d608c","_postman_id":"528b0176-898a-4c30-bde9-87ebce0d608c","description":""},{"name":"Participants","item":[{"name":"List Participants","id":"329b5604-ce03-4dac-b7d7-c7e2265bd67a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
interview	String	Key of the interview	Optional
department	String	Key of the department	Optional
owner	String	Key of the owner	Optional
search	String	Search by name, email, interview title	Optional
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	-created_at (default) created_at name -name

","urlObject":{"path":["participants",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"91628254-587e-4b55-9dde-2738a6dbcc5a","name":"List Participants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base_url}}/participants/?interview&department&owner&search&ordering&page_size","host":["{{base_url}}"],"path":["participants",""],"query":[{"key":"interview","value":null,"description":"key of the interview"},{"key":"department","value":null,"description":"key of the department"},{"key":"owner","value":null,"description":"key of the interview owner"},{"key":"search","value":null,"description":"query text"},{"key":"ordering","value":null,"description":"order by field"},{"key":"page_size","value":null,"description":"amount of items per page","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"3188e2b26c8648aeba46bc8f00f5835d\",\n \"name\": \"Rosa Parks\",\n \"email\": \"rosa.parks@yahoo.com\",\n \"phone\": \"+123843854383443\",\n \"interview\": {\n \"key\": \"c0ac90a5e04e4dbaa1339a42b562ac00\",\n \"title\": \"Activist\"\n },\n \"department\": {\n \"key\": \"c8a065f2f0454bb681f8212446c16bd9\",\n \"name\": \"HR\"\n },\n \"created_at\": \"2022-08-11T14:12:00.941442Z\",\n \"location\": {\n \"city\": \"London\",\n \"country_name\": \"United Kingdom\",\n \"country_code\": \"GB\"\n },\n \"showcase_link\": \"https://willotalent.com/3v3v34/\",\n \"overview_link\": \"https://willotalent.com/interviwer/3v3v34/\",\n \"avatar_remote_link\": \"https://willotalent.com/avatar.png/\",\n \"custom_id\": \"can_12345\",\n \"availability\": [\"2022-08-15T01:30:00Z\", \"2022-08-16T01:30:00Z\", \"2022-08-17T01:30:00Z\"]\n }\n ]\n}"}],"_postman_id":"329b5604-ce03-4dac-b7d7-c7e2265bd67a"},{"name":"Invite Participant","id":"daf27183-9bbc-47c6-9f12-1ed202ec5432","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/participants/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
interview	String	Key of the interview	Required
email	String	Email address of the participant	Required
name	String	Name of the participant	Required
phone	String	Phone number of the participant	Optional
send_notifications	Boolean	Flag to configure candidate invitations / reminders (Default is True)	Optional	True/False
custom_id	String	Participant ID in your service	Optional

","urlObject":{"path":["participants",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c0e471b0-ef66-46f9-870d-aed9449c652d","name":"Invite Participant","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"interview\": \"12f46389d89b410ba75cff562a52b679\",\n \"email\": \"rosa.parks@yahoo.com\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+13373484584543\",\n \"send_notifications\": true,\n \"custom_id\": \"can_123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.stage.willotalent.com/api/integrations/v2/participants/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n \"email\": \"rosa.parks@yahoo.com\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+13373484584543\",\n \"status\": \"Invited\",\n \"send_notifications\": true,\n \"custom_id\": \"can_123456\",\n \"invite_link\": \"https://willotalent.com/invite/43f432/\",\n \"interview\": {\n \"key\": \"12f46389d89b410ba75cff562a52b679\",\n \"title\": \"Activist\"\n },\n \"department\": {\n \"key\": \"c8a065f2f0454bb681f8212446c16bd9\",\n \"name\": \"HR\"\n },\n \"created_at\": \"2022-08-15T01:30:00Z\"\n}"}],"_postman_id":"daf27183-9bbc-47c6-9f12-1ed202ec5432"},{"name":"Participant Details","id":"5c0a2d70-4775-4a94-8f04-6f70dc365c48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants//","description":"

Note: Example for the payload with Multiple Choice type question provided in Example Response under \"Retrieve Participant With Multiple Choice Question\" tab

\n","urlObject":{"path":["participants","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2b181bdd-40a2-4920-bf49-811ed05ff748","name":"Retrieve Participant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/participants//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n \"email\": \"rosa.parks@yahoo.com\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+13373484584543\",\n \"status\": \"Invited\",\n \"status_changed_by\": \"steve@apple.com\",\n \"status_changed_at\": \"2022-08-15T01:30:00Z\",\n \"send_notifications\": true,\n \"custom_id\": \"can_123456\",\n \"summary\": \"The candidate defines civil rights as fundamental freedoms and legal protections ensuring equal and fair treatment for all, regardless of personal characteristics.\",\n \"interview\": {\n \"key\": \"12f46389d89b410ba75cff562a52b679\",\n \"title\": \"Activist\"\n },\n \"department\": {\n \"key\": \"c8a065f2f0454bb681f8212446c16bd9\",\n \"name\": \"HR\"\n },\n \"created_at\": \"2022-08-15T01:30:00Z\",\n \"updated_at\": \"2022-08-15T01:30:00Z\",\n \"location\": {\n \"city\": \"Detroit\",\n \"country_name\": \"United States\",\n \"country_code\": \"US\"\n },\n \"showcase_link\": \"https://willotalent.com/3v3v34/\",\n \"candidate_overview_link\": \"https://willotalent.com/interviwer/3v3v34/\",\n \"avatar_remote_link\": \"https://willotalent.com/avatar.png/\",\n \"availability\": [\"2022-08-15T01:30:00Z\", \"2022-08-16T01:30:00Z\", \"2022-08-17T01:30:00Z\"],\n \"score\": {\n \"average_score_snapshot\": 4.5,\n \"average_score_count\": 2,\n \"average_score_updated_at\": \"2025-02-16T09:00:30Z\"\n },\n \"answers\": [\n {\n \"key\": \"d0e74f1cf8224bf1bbdb7dc51d9d5a9e\",\n \"created_at\": \"2022-08-10T01:30:00Z\",\n \"updated_at\": \"2022-08-10T01:30:00Z\",\n \"is_finished\": true,\n \"media_extension\": \"mp4\",\n \"remote_link\": \"https://willotalent.com/3fvdvhj34v.mp4/\",\n \"is_media_deleted\": false,\n \"text\": null,\n \"spent_time\": 143,\n \"additional_info\": {\"share_code\": \"AAA-BBB-CCC\"},\n \"type_specific_data\": {},\n \"transcript\": {\n \"text\": \"Civil rights refer to the fundamental freedoms and protections that ensure individuals are treated equally and justly under the law, regardless of race, gender, or other characteristics.\",\n \"language\": \"en\",\n \"confidence\": 0.9\n },\n \"status\": \"processed\",\n \"reason\": null,\n \"question\": {\n \"key\": \"46c8b4dff2364f37ac3ad90f72349716\",\n \"text\": \"What does the term 'Civil rights' mean to you?\",\n \"order\": 1,\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"answer_type\": \"video\",\n \"thinking_time\": 300,\n \"max_characters\": null,\n \"max_words\": null,\n \"type_specific_data\": {}\n }\n }\n ]\n}"},{"id":"1b381e58-07df-4b0f-a42f-2633fc4eba78","name":"Retrieve Participant With Checkbox Question","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/participants//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n \"email\": \"rosa.parks@yahoo.com\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+13373484584543\",\n \"status\": \"Invited\",\n \"status_changed_by\": \"steve@apple.com\",\n \"status_changed_at\": \"2022-08-15T01:30:00Z\",\n \"send_notifications\": true,\n \"custom_id\": \"can_123456\",\n \"summary\": \"The candidate defines civil rights as fundamental freedoms and legal protections ensuring equal and fair treatment for all, regardless of personal characteristics.\",\n \"interview\": {\n \"key\": \"12f46389d89b410ba75cff562a52b679\",\n \"title\": \"Activist\"\n },\n \"department\": {\n \"key\": \"c8a065f2f0454bb681f8212446c16bd9\",\n \"name\": \"HR\"\n },\n \"created_at\": \"2022-08-15T01:30:00Z\",\n \"updated_at\": \"2022-08-15T01:30:00Z\",\n \"location\": {\n \"city\": \"Detroit\",\n \"country_name\": \"United States\",\n \"country_code\": \"US\"\n },\n \"showcase_link\": \"https://willotalent.com/3v3v34/\",\n \"candidate_overview_link\": \"https://willotalent.com/interviwer/3v3v34/\",\n \"avatar_remote_link\": \"https://willotalent.com/avatar.png/\",\n \"availability\": [\"2022-08-15T01:30:00Z\", \"2022-08-16T01:30:00Z\", \"2022-08-17T01:30:00Z\"],\n \"score\": {\n \"average_score_snapshot\": null,\n \"average_score_count\": 0,\n \"average_score_updated_at\": null\n },\n \"answers\": [\n {\n \"key\": \"d0e74f1cf8224bf1bbdb7dc51d9d5a9e\",\n \"created_at\": \"2022-08-10T01:30:00Z\",\n \"updated_at\": \"2022-08-10T01:30:00Z\",\n \"is_finished\": true,\n \"media_extension\": \"mp4\",\n \"remote_link\": \"https://willotalent.com/3fvdvhj34v.mp4/\",\n \"is_media_deleted\": false,\n \"text\": null,\n \"spent_time\": 143,\n \"additional_info\": {\"share_code\": \"AAA-BBB-CCC\"},\n \"transcript\": {\n \"text\": \"Civil rights refer to the fundamental freedoms and protections that ensure individuals are treated equally and justly under the law, regardless of race, gender, or other characteristics.\",\n \"language\": \"en\",\n \"confidence\": 0.9\n },\n \"status\": \"processed\",\n \"reason\": null,\n \"type_specific_data\": {\n \"selected_answer_options\": [\n {\n \"key\": \"9238b4dff2364f37akk8d90f72349009\",\n \"option\": \"998065f2f0454bb681f8212446c16bd9\",\n \"is_correct\": true\n }\n ]\n },\n \"question\": {\n \"key\": \"46c8b4dff2364f37ac3ad90f72349716\",\n \"text\": \"Do you have driver licence?\",\n \"order\": 1,\n \"max_duration\": 60,\n \"max_retakes\": 5,\n \"answer_type\": \"multiple_choice\",\n \"thinking_time\": 300,\n \"max_characters\": null,\n \"max_words\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"998065f2f0454bb681f8212446c16bd9\",\n \"text\": \"Yes\",\n \"order\": 1,\n \"is_correct\": true\n },\n {\n \"key\": \"478365f2fhd343j81f8212446h4hs9k\",\n \"text\": \"No\",\n \"order\": 2,\n \"is_correct\": false\n }\n ]\n }\n }\n }\n ]\n}"}],"_postman_id":"5c0a2d70-4775-4a94-8f04-6f70dc365c48"},{"name":"Update Participant (PUT)","id":"641926ba-116e-492f-ba65-bff857ec0def","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Alex Doe\",\n \"phone\": \"+18483438384348\",\n \"custom_id\": \"can_999999\",\n \"status\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/participants//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
name	String	Name of the participant	Optional
phone	String	Phone number of the participant	Optional
status	String	Participant status	Optional	Accepted Rejected
custom_id	String	Participant ID in your service	Optional

","urlObject":{"path":["participants","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5aafb330-e377-42fc-bfd6-ee2885518ebb","name":"Update Participant (PUT)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Rosa Parks\",\n \"phone\": \"+18483438384348\",\n \"custom_id\": \"can_999999\",\n \"status\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/participants//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+18483438384348\",\n \"status\": \"Accepted\",\n \"custom_id\": \"can_999999\"\n}"}],"_postman_id":"641926ba-116e-492f-ba65-bff857ec0def"},{"name":"Update Participant (PATCH)","id":"f673a4fa-4132-4505-9ca5-bf7d801054fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
name	String	Name of the participant	Optional
phone	String	Phone number of the participant	Optional
status	String	Participant status	Optional	Accepted Rejected
custom_id	String	Participant ID in your service	Optional

","urlObject":{"path":["participants","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"93a9c53f-c631-43ee-b116-0da278b21de3","name":"Update Participant (PATCH)","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Rosa Parks\",\n \"phone\": \"+18483438384348\",\n \"custom_id\": \"can_999999\",\n \"status\": \"Accepted\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/participants//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n \"name\": \"Rosa Parks\",\n \"phone\": \"+18483438384348\",\n \"status\": \"Accepted\",\n \"custom_id\": \"can_999999\"\n}"}],"_postman_id":"f673a4fa-4132-4505-9ca5-bf7d801054fd"},{"name":"Delete Participant","id":"ebf1e77c-653d-4fff-b59a-4ada7dd46b60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants//","urlObject":{"path":["participants","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f45b8738-a313-4c6d-b710-7b829192842c","name":"Delete Participant","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/participants//"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ebf1e77c-653d-4fff-b59a-4ada7dd46b60"},{"name":"Participant Identity Verification Details","id":"c92027a8-d919-4ea7-a7bc-9b56c09e4f6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants//idv-info/","description":"

There are four possible check_type options: idv , rtw , dbs, dbs_rtw
idv stands for Identity Verification

rtw stands for Right to Work Verification
dbs stands for Disclosure and Barring Service
dbs_rtw stands for Disclosure and Barring Service check for Right to Work Verification

In case of idv the field` identity_profile_media_data` will be empty and identity_profile key will be missed in session_data

\n","urlObject":{"path":["participants","","idv-info",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b0abfd8a-810a-4f97-a1b0-775431d55943","name":"Participant Identity Verification Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/participants//idv-info/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"check_type\": \"rtw\",\n \"status\": \"completed\",\n \"share_code\": \"FFF-FFF-FFF\",\n \"session_data\": {\n \"client_session_token_ttl\": 8698,\n \"session_id\": \"e97d4a86-5d75-41ca-9653-7e8f60c3f0c1\",\n \"state\": \"COMPLETED\",\n \"resources\": {\n \"id_documents\": [\n {\n \"id\": \"7b62fb23-18fd-43e8-bd03-986064d6419d\",\n \"tasks\": [\n {\n \"type\": \"ID_DOCUMENT_TEXT_DATA_EXTRACTION\",\n \"id\": \"07159ef6-79b7-43e8-8f06-7c72663ca108\",\n \"state\": \"DONE\",\n \"created\": \"2022-09-06T08:25:57Z\",\n \"last_updated\": \"2022-09-06T08:26:29Z\",\n \"generated_checks\": [],\n \"generated_media\": [\n {\n \"id\": \"0a2bbf4c-ca77-4c76-b52b-d523678be6f4\",\n \"type\": \"JSON\"\n }\n ]\n }\n ],\n \"source\": {\n \"type\": \"END_USER\"\n },\n \"document_type\": \"PASSPORT\",\n \"issuing_country\": \"GBR\",\n \"pages\": [\n {\n \"capture_method\": \"UPLOAD\",\n \"media\": {\n \"id\": \"26eb5005-b202-478f-a549-e4521fc78f95\",\n \"type\": \"IMAGE\",\n \"created\": \"2022-09-06T08:26:26Z\",\n \"last_updated\": \"2022-09-06T08:26:26Z\"\n },\n \"frames\": [\n {\n \n },\n {\n \n },\n {\n \n }\n ]\n }\n ],\n \"document_fields\": {\n \"media\": {\n \"id\": \"0a2bbf4c-ca77-4c76-b52b-d523678be6f4\",\n \"type\": \"JSON\",\n \"created\": \"2022-09-06T08:26:29Z\",\n \"last_updated\": \"2022-09-06T08:26:29Z\"\n }\n },\n \"document_id_photo\": {\n \"media\": {\n \"id\": \"5c504ac6-f5dd-4e38-a1ef-6d5f122dddf8\",\n \"type\": \"IMAGE\",\n \"created\": \"2022-09-06T08:26:29Z\",\n \"last_updated\": \"2022-09-06T08:26:29Z\"\n }\n }\n },\n {\n \"id\": \"bc548695-a57f-4720-8eab-0f936aa85e10\",\n \"tasks\": [\n {\n \"type\": \"ID_DOCUMENT_TEXT_DATA_EXTRACTION\",\n \"id\": \"273b9a62-9bf8-451f-ab9a-64224979bfcd\",\n \"state\": \"CREATED\",\n \"created\": \"2022-09-06T08:25:17Z\",\n \"last_updated\": \"2022-09-06T08:25:17Z\",\n \"generated_checks\": [],\n \"generated_media\": []\n }\n ],\n \"source\": {\n \"type\": \"END_USER\"\n },\n \"document_type\": \"PASSPORT\",\n \"issuing_country\": \"GBR\",\n \"pages\": [\n {\n \"frames\": [\n {\n \n },\n {\n \n },\n {\n \n }\n ]\n }\n ]\n }\n ],\n \"supplementary_documents\": [],\n \"liveness_capture\": [\n {\n \"id\": \"edc699e5-efe4-4b4c-85cc-a23980c50692\",\n \"tasks\": [],\n \"source\": {\n \"type\": \"END_USER\"\n },\n \"frames\": [\n {\n \"media\": {\n \"id\": \"44bd7d66-6b4a-4d9e-8759-aef392c0dd38\",\n \"type\": \"IMAGE\",\n \"created\": \"2022-09-06T08:26:58Z\",\n \"last_updated\": \"2022-09-06T08:26:58Z\"\n }\n },\n {\n \"media\": {\n \"id\": \"da5dc1c8-cdb4-4fdd-b92d-a6dc0cd6acbb\",\n \"type\": \"IMAGE\",\n \"created\": \"2022-09-06T08:26:58Z\",\n \"last_updated\": \"2022-09-06T08:26:58Z\"\n }\n },\n {\n \"media\": {\n \"id\": \"dee24718-2a61-4309-a5be-737394bc29cf\",\n \"type\": \"IMAGE\",\n \"created\": \"2022-09-06T08:26:58Z\",\n \"last_updated\": \"2022-09-06T08:26:58Z\"\n }\n },\n {\n \n },\n {\n \n },\n {\n \n },\n {\n \n }\n ],\n \"liveness_type\": \"ZOOM\",\n \"facemap\": {\n \"media\": {\n \"id\": \"c3817dab-51ae-4579-a449-21927431ff1a\",\n \"type\": \"BINARY\",\n \"created\": \"2022-09-06T08:27:02Z\",\n \"last_updated\": \"2022-09-06T08:27:02Z\"\n }\n }\n }\n ],\n \"face_capture\": [],\n \"applicant_profiles\": []\n },\n \"checks\": [\n {\n \"type\": \"ID_DOCUMENT_AUTHENTICITY\",\n \"id\": \"82e90734-84ff-4c9e-9d2c-b6f0a2f9e5fe\",\n \"state\": \"DONE\",\n \"resources_used\": [\n \"edc699e5-efe4-4b4c-85cc-a23980c50692\",\n \"7b62fb23-18fd-43e8-bd03-986064d6419d\"\n ],\n \"generated_media\": [],\n \"report\": {\n \"recommendation\": {\n \"value\": \"APPROVE\"\n },\n \"breakdown\": [\n {\n \"sub_check\": \"age_estimation_dob_comparison\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"document_in_date\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"fraud_list_check\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"hologram\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"hologram_movement\",\n \"result\": \"FAIL\",\n \"details\": []\n },\n {\n \"sub_check\": \"mrz_validation\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"no_sign_of_forgery\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"no_sign_of_tampering\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"ocr_mrz_comparison\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"other_security_features\",\n \"result\": \"PASS\",\n \"details\": []\n },\n {\n \"sub_check\": \"physical_document_captured\",\n \"result\": \"PASS\",\n \"details\": []\n }\n ]\n },\n \"created\": \"2022-09-06T08:27:05Z\",\n \"last_updated\": \"2022-09-06T08:29:49Z\"\n },\n {\n \"type\": \"LIVENESS\",\n \"id\": \"47c53a5a-c380-4b63-a53d-bc3a2f36467f\",\n \"state\": \"DONE\",\n \"resources_used\": [\n \"edc699e5-efe4-4b4c-85cc-a23980c50692\"\n ],\n \"generated_media\": [],\n \"report\": {\n \"recommendation\": {\n \"value\": \"APPROVE\"\n },\n \"breakdown\": [\n {\n \"sub_check\": \"liveness_auth\",\n \"result\": \"PASS\",\n \"details\": []\n }\n ]\n },\n \"created\": \"2022-09-06T08:27:05Z\",\n \"last_updated\": \"2022-09-06T08:27:05Z\"\n },\n {\n \"type\": \"ID_DOCUMENT_FACE_MATCH\",\n \"id\": \"c29db779-fa57-4763-9224-daf954952d79\",\n \"state\": \"DONE\",\n \"resources_used\": [\n \"edc699e5-efe4-4b4c-85cc-a23980c50692\",\n \"7b62fb23-18fd-43e8-bd03-986064d6419d\"\n ],\n \"generated_media\": [],\n \"report\": {\n \"recommendation\": {\n \"value\": \"APPROVE\"\n },\n \"breakdown\": [\n {\n \"sub_check\": \"ai_face_match\",\n \"result\": \"FAIL\",\n \"details\": [\n {\n \"name\": \"confidence_score\",\n \"value\": \"0.57\"\n }\n ]\n },\n {\n \"sub_check\": \"manual_face_match\",\n \"result\": \"PASS\",\n \"details\": []\n }\n ]\n },\n \"created\": \"2022-09-06T08:27:05Z\",\n \"last_updated\": \"2022-09-06T08:29:55Z\"\n },\n {\n \"type\": \"THIRD_PARTY_IDENTITY_FRAUD_1\",\n \"id\": \"5f5e5bab-d5a6-43be-ac43-85ee9a69811b\",\n \"state\": \"DONE\",\n \"resources_used\": [\n \"7b62fb23-18fd-43e8-bd03-986064d6419d\"\n ],\n \"generated_media\": [\n {\n \"id\": \"0a82d85d-ecd9-4dce-841a-954c164e508a\",\n \"type\": \"JSON\"\n }\n ],\n \"report\": {\n \"recommendation\": {\n \"value\": \"APPROVE\"\n },\n \"breakdown\": [\n {\n \"sub_check\": \"check_performed\",\n \"result\": \"PASS\",\n \"details\": [\n {\n \"name\": \"provider_org\",\n \"value\": \"redacted/IDFP_1\"\n }\n ]\n }\n ]\n },\n \"created\": \"2022-09-06T08:29:55Z\",\n \"last_updated\": \"2022-09-06T08:29:56Z\",\n \"generated_profile\": {\n \"media\": {\n \"id\": \"0a82d85d-ecd9-4dce-841a-954c164e508a\",\n \"type\": \"JSON\",\n \"created\": \"2022-09-06T08:29:56Z\",\n \"last_updated\": \"2022-09-06T08:29:56Z\"\n }\n }\n }\n ],\n \"biometric_consent\": \"2022-09-06T08:26:41Z\",\n \"identity_profile\": {\n \"result\": \"DONE\",\n \"identity_profile_report\": {\n \"trust_framework\": \"UK_TFIDA\",\n \"media\": {\n \"id\": \"b99f6c43-64d8-429b-a42f-8b37519df2a1\",\n \"type\": \"JSON\",\n \"created\": \"2022-09-06T08:29:56Z\",\n \"last_updated\": \"2022-09-06T08:29:56Z\"\n },\n \"schemes_compliance\": [\n {\n \"scheme\": {\n \"type\": \"RTW\",\n \"objective\": \"\"\n },\n \"requirements_met\": true\n }\n ]\n }\n }\n },\n \"document_text_extraction\": {\n \"full_name\": \" Steven Paul Jobs\",\n \"date_of_birth\": \"1955-10-11\",\n \"given_names\": \"Steven Paul\",\n \"family_name\": \"Jobs\",\n \"place_of_birth\": \"California\",\n \"document_type\": \"DRIVING_LICENCE\",\n \"issuing_country\": \"US\",\n \"document_number\": \"KBH32990\",\n \"expiration_date\": \"2049-12-07\",\n \"date_of_issue\": \"2019-12-07\",\n \"issuing_authority\": \"TLL 3111\"\n },\n \"identity_profile_media_data\": {\n \"proof\":{\n \"jws\":\"eyJhbGciOiJFZERTQSIsImtpZCI6IdhdhdhhdhdhhdhZkfVx1ZmZmZGFcdWZmZmRcdWZmZmRcdWZmZmRmXHUwMDEyXHVmZmZkNFx1MDAxNFx1MDAwMFx1ZmZmZDAkXHVmZmZkbVx1ZmZmZD8_XHUwMDI2XHVmZmZkQVx1ZmZmZFx1ZmZmZFx1ZmZmZCJ9..LHAOaP18CkyWq4xrKYGOdeOe2GEEMxRDx2rn4yHjvdkofd99dfd-v-fdvfdvxWIEu4ZU_FmDrGgZd04GDg\",\n \"public_key_url\":\"https://vc.core.yoti.com/v1/id-profile/v1/key\"\n },\n \"identity_assertion\":{\n \"current_name\":{\n \"full_name\":\"STEVEN PAUL JOBS\",\n \"first_name\":\"STEVEN\",\n \"family_name\":\"JOBS\",\n \"given_names\":\"STEVEN PAUL\",\n \"middle_name\":\"PAUL\"\n },\n \"date_of_birth\":\"1955-02-12\",\n \"current_address\":\"None\"\n },\n \"verification_report\":{\n \"evidence\":{\n \"face\":{\n \"check_ids\":[\n \"efkkec88-e155-40da-9768-09980cac521b\"\n ],\n \"evidence_id\":\"893hh333-f5ef-4e91-8479-06334j33b5e\",\n \"resource_ids\":[\n \"ce21df33be59-405f-8e65-453o3432j32\"\n ],\n \"verifying_org\":\"Yoti Ltd\",\n \"initial_liveness\":{\n \"type\":\"ZOOM\",\n \"timestamp\":\"2022-10-20T10:59:03Z\"\n },\n \"user_activity_ids\":[\n \n ],\n \"selfie_attribute_id\":\"\",\n \"last_matched_liveness\":{\n \"type\":\"ZOOM\",\n \"timestamp\":\"2022-10-20T10:59:03Z\"\n }\n },\n \"documents\":[\n {\n \"check_ids\":[\n \"405559d4-a25c-487b-9460-9062874d20b8\"\n ],\n \"timestamp\":\"2022-10-20T10:59:40Z\",\n \"evidence_id\":\"34343jj0-1982-4aeb-984a-h34h3433e238\",\n \"resource_ids\":[\n \"26ead2ef-d940-412a-b901-f9c455696070\"\n ],\n \"passed_checks\":[\n {\n \"check\":\"DOCUMENT_IN_DATE\"\n },\n {\n \"check\":\"MANUAL_VISUAL_DOCUMENT_AUTHENTICITY\"\n },\n {\n \"check\":\"FRAUD_DOCUMENTS_LIST\"\n },\n {\n \"check\":\"AUTOMATED_FACE_MATCH\"\n }\n ],\n \"verifying_org\":\"Yoti Ltd\",\n \"document_fields\":{\n \"mrz\":{\n \"type\":2,\n \"line1\":\"PIntegration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/participants//idv-media/","description":"

Return media provided by participand during identity verification.

key value for url parameter can be taken from /api/integrations/v2/participants/{key}/idv-info/ API.

\n","urlObject":{"path":["participants","","idv-media",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3b3adb88-103e-482a-99a8-66da5c02cf02","name":"Participant Identity Verification Media","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/participants//idv-media/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"image/png","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a25517e3-2baf-4dd2-b808-94c9616f1dca"}],"id":"de33b74c-2cee-4aed-ba7b-fb29ec27be1f","_postman_id":"de33b74c-2cee-4aed-ba7b-fb29ec27be1f","description":""},{"name":"Users","item":[{"name":"List Users","id":"1e86af40-6816-43eb-96ae-3873a25f4ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/users/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	full_name -full_name

","urlObject":{"path":["users",""],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"0f84ba66-d7bd-4527-8fd3-4e9c475f4a6d","name":"List Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base_url}}/users/","host":["{{base_url}}"],"path":["users",""],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"8156b6da320f4e429d56c50f19690c69\",\n \"email\": \"amelia.earhart@willo.video\",\n \"full_name\": \"Amelia Mary Earhart\"\n }\n ]\n}"}],"_postman_id":"1e86af40-6816-43eb-96ae-3873a25f4ad5"},{"name":"Invite User","id":"feac0014-3f9f-4b03-b36d-76822b7c6070","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/users/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
email	String	Email address of user	Required
role	String	User role in organisation	Required	admin, standard

","urlObject":{"path":["users",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"77e61d81-27c8-4b6b-8b37-5f5e228ce77e","name":"Invite User","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@willo.video\",\n \"role\": \"standard\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"257e486817374011be3cb5adbe7574ef\",\n \"email\": \"john.doe@willo.video\",\n \"full_name\": \"John Doe\",\n \"role\": \"standard\",\n \"status\": \"joined\",\n \"phone\": \"+132443545343\"\n}"}],"_postman_id":"feac0014-3f9f-4b03-b36d-76822b7c6070"},{"name":"User Details","id":"5b6db36f-d36b-4f85-a640-df29a3e5aed2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/users//","urlObject":{"path":["users","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f002f615-192b-4960-b6fd-a9b3bd0acf4b","name":"User Details","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/users//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"257e486817374011be3cb5adbe7574ef\",\n \"email\": \"amelia.aerhart@willo.video\",\n \"full_name\": \"Amelia Mary Earhart\",\n \"phone\": \"+132443545343\",\n \"role\": \"standard\",\n \"status\": \"joined\"\n}"}],"_postman_id":"5b6db36f-d36b-4f85-a640-df29a3e5aed2"},{"name":"Update User (PATCH)","id":"f3239300-9181-4f89-9dc3-ba4fffde814b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/users//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
role	String	User role in organisation	Required	admin, standard

","urlObject":{"path":["users","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9606fe22-0988-422e-a048-614e64b1db51","name":"Update User (PATCH)","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"Integration key available in Connect section of Willo","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"role\": \"admin\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/users//"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"257e486817374011be3cb5adbe7574ef\",\n \"email\": \"amelia.aerhart@willo.video\",\n \"full_name\": \"Amelia Mary Earhart\",\n \"phone\": \"+132443545343\",\n \"role\": \"admin\",\n \"status\": \"joined\"\n}"}],"_postman_id":"f3239300-9181-4f89-9dc3-ba4fffde814b"},{"name":"Delete User","id":"8dda2121-0dd7-4a50-8128-998e86d7f8b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/users//","urlObject":{"path":["users","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"71506f3e-d776-4da3-8696-52ea488e2875","name":"Delete User","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/users//"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8dda2121-0dd7-4a50-8128-998e86d7f8b5"}],"id":"85deeb1e-8f9f-4582-862d-2afb6734d8b5","_postman_id":"85deeb1e-8f9f-4582-862d-2afb6734d8b5","description":""},{"name":"Webhooks","item":[{"name":"List Webhooks","id":"5db750af-5fa6-40e5-b581-7189a15bff94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/webhooks/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
follow_all_interviews	Boolean	true/false value of follow all	Optional	true/false
event	String	Event type	Optional
interview	String	Key of the interview	Optional
page_size	Integer	Size of response page	Optional	1...30
ordering	String	comma separated list of fields to order by	Optional	created_at -created_at

","urlObject":{"path":["webhooks",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a73b760c-84ff-4f6a-b1c4-3ead5ae8d78d","name":"List Webhooks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/webhooks/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"a4444502dae4468a95ecc929fb2eca7e\",\n \"interviews\": [\n {\n \"key\": \"0fdea1df673040c89924f019419a440d\",\n \"title\": \"Product Manager\"\n }\n ],\n \"departments\": {\n \"key\": \"8idea1df6730k349924f019419ajer4\",\n \"name\": \"IT Solutions\"\n },\n \"users\": [\n {\n \"key\": \"6ygjf1df6730k437924f0194h6g79h\",\n \"full_name\": \"John Doe\",\n \"email\": \"john@doe.com\"\n }\n ],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"stage_change\",\n \"payload_configuration\": {\n \"return_transcripts\": false,\n \"return_summary\": false\n }\n },\n {\n \"key\": \"a4444502dae4468a95ecc929fb2eca7e\",\n \"interviews\": [],\n \"follow_all_interviews\": true,\n \"url\": \"https://your-site.com\",\n \"event\": \"accepted\",\n \"payload_configuration\": {\n \"return_transcripts\": true,\n \"return_summary\": true\n }\n }\n ]\n}"}],"_postman_id":"5db750af-5fa6-40e5-b581-7189a15bff94"},{"name":"Create Webhook","id":"2d6dcf2a-ebcf-42e6-9c66-5710154f0a98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/webhooks/","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
follow_all_interviews	Boolean	true/false value of follow all	Optional	true/false
interviews	List[String]	Array of interview keys; (Use an array with at least one interview key in case follow_all_interviews is True)	Optional
departments	List[String]	Array of department keys. This field can be combined with the \"interviews\" and \"users\" fields using an OR condition to filter results across multiple criteria	Optional
users	List[String]	Array of user keys. This field can be combined with the \"departments\" and \"interviews\" fields using an OR condition to filter results across multiple criteria	Optional
url	String	URL to update	Required
event	String	The event type that triggers a callback	Required	new_response, status_change, new_comment, new_score
token	String	The token that will be included in the \"Authorization\" header of the callback	Optional	max length is 128 characters
payload_configuration[return_transcripts]	Boolean	Configuration of notification payload for answers transcript. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false
payload_configuration[return_summary]	Boolean	Configuration of notification payload for candidade summary. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false

Please note: There may be a delay in receiving callbacks while media is processed.

Given webhook will send you back the POST request to configured url.
For new_response and stage_change event type you wil receive a webhook with the following body:

{\n  \"key\": \"d7964979cd364d59b3d6c457712d8857\",\n  \"email\": \"rosa.parks@yahoo.com\",\n  \"name\": \"Rosa Parks\",\n  \"phone\": \"+13373484584543\",\n  \"status\": \"Invited\",\n  \"status_changed_by\": \"steve@apple.com\",\n  \"status_changed_at\": \"2022-08-15T01:30:00Z\",\n  \"send_notifications\": true,\n  \"custom_id\": \"can_123456\",\n  \"interview\": {\n    \"key\": \"12f46389d89b410ba75cff562a52b679\",\n    \"title\": \"Activist\"\n  },\n  \"department\": {\n    \"key\": \"c8a065f2f0454bb681f8212446c16bd9\",\n    \"name\": \"HR\"\n  },\n  \"created_at\": \"2022-08-15T01:30:00Z\",\n  \"updated_at\": \"2022-08-15T01:30:00Z\",\n  \"location\": {\n    \"city\": \"Detroit\",\n    \"country_name\": \"United States\",\n    \"country_code\": \"US\"\n  },\n  \"showcase_link\": \"https://willotalent.com/3v3v34/\",\n  \"candidate_overview_link\": \"https://willotalent.com/interviwer/3v3v34/\",\n  \"avatar_remote_link\": \"https://willotalent.com/avatar.png/\",\n  \"availability\": [\n    \"2022-08-15T01:30:00Z\",\n    \"2022-08-16T01:30:00Z\",\n    \"2022-08-17T01:30:00Z\"\n  ],\n  \"summary\": \"The candidate completed a set of interview questions, demonstrating confident knowledge of the topic and provided examples\"\n  \"answers\": [\n    {\n      \"key\": \"d0e74f1cf8224bf1bbdb7dc51d9d5a9e\",\n      \"created_at\": \"2022-08-10T01:30:00Z\",\n      \"updated_at\": \"2022-08-10T01:30:00Z\",\n      \"is_finished\": true,\n      \"media_extension\": \"mp4\",\n      \"remote_link\": \"https://willotalent.com/3fvdvhj34v.mp4/\",\n      \"is_media_deleted\": false,\n      \"text\": null,\n      \"spent_time\": 143,\n      \"status\": \"processed\",\n      \"reason\": null,\n      \"transcript\": {\n        \"text\": \"I have a lot of experience in public speaches\",\n        \"language\": \"en\",\n        \"confidence\": 0.9\n      },\n      \"additional_info\": {},\n      \"type_specific_data\": {},\n      \"question\": {\n        \"key\": \"46c8b4dff2364f37ac3ad90f72349716\",\n        \"text\": \"What does the term 'Civil rights' mean to you?\",\n        \"order\": 1,\n        \"max_duration\": 60,\n        \"max_retakes\": 5,\n        \"answer_type\": \"video\",\n        \"thinking_time\": 300,\n        \"max_characters\": null,\n        \"max_words\": null,\n        \"type_specific_data\": {},\n      }\n    }\n  ]\n}\n\n

For new_comment event type you wil receive a webhook with the following body:

{\n    \"id\": \"evt_JkcWU6EKtEaDgTBoZ6EFWtAR\",\n    \"api_version\": \"v1\",\n    \"type\": \"new_comment\",\n    \"data\": {\n        \"participant\": {\n            \"key\": \"c990f380bf7f49b79783b79c67459e33\",\n            \"name\": \"Rosa Parks\",\n            \"email\": \"rosa.parks@yahoo.com\",\n        },\n        \"comment\": {\n            \"key\": \"3d0368276ca640b8bed82e979cf42ea0\",\n            \"text\": \"Very good understanding of sales processes\",\n            \"created_at\": \"2025-01-13T10:13:59.391874+00:00\",\n            \"author\": {\n                \"key\": \"5699b3503832466bb33e6b86bc8c76f8\",\n                \"full_name\": \"Steve Doe\",\n                \"email\": \"steve@doe.com\"\n            }\n        }\n    }\n}\n\n

For new_score event type you wil receive a webhook with the following body:

{\n    \"id\": \"evt_JkcWU6EKtEaDgTBoZ6EFWtAR\",\n    \"api_version\": \"v1\",\n    \"type\": \"new_score\",\n    \"data\": {\n        \"participant\": {\n            \"key\": \"c990f380bf7f49b79783b79c67459e33\",\n            \"name\": \"Rosa Parks\",\n            \"email\": \"rosa.parks@yahoo.com\",\n            \"avg_score\": \"5.00\"\n        },\n        \"score\": {\n            \"key\": \"10e097f5867a4226adc83665dac0559d\",\n            \"general_score\": \"5.00\",\n            \"scored_at\": \"2025-01-13T10:13:59.391874+00:00\",\n            \"scored_by\": {\n                \"key\": \"5699b3503832466bb33e6b86bc8c76f8\",\n                \"full_name\": \"Steve Doe\",\n                \"email\": \"steve@doe.com\"\n            },\n            \"scores_by_criteria\": [           \n                {\n                    \"key\": \"b90451d46dce4e2cad1bb949a1285b9d\",\n                    \"scorecard_criteria\": {\n                        \"key\": \"87ddc266d9e940608641fc6fc27bc655\",\n                        \"text\": \"Communication skills\",\n                        \"description\": \"How effectively candidate can communicate\",\n                        \"order\": 1,\n                        \"is_optional\": false\n                    },\n                    \"score\": \"5.00\"\n                }\n            ]\n        }\n    }\n}\n\n

\n","urlObject":{"path":["webhooks",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"25cff9cc-8b8b-40a4-afe6-3428537f6f2b","name":"Create Webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"interviews\": [\"e09e51faa3d841729012a918bde1538a\"],\n \"departments\": [],\n \"users\": [],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"stage_change\",\n \"payload_configuration\": {\n \"return_transcripts\": false,\n \"return_summary\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/webhooks/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"a4444502dae4468a95ecc929fb2eca7e\",\n \"interviews\": [\n {\n \"key\": \"e09e51faa3d841729012a918bde1538a\",\n \"title\": \"Product Manager\"\n }\n ],\n \"departments\": [],\n \"users\": [],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"status_change\",\n \"token\": \"some-token\",\n \"payload_configuration\": {\n \"return_transcripts\": false,\n \"return_summary\": false\n }\n}"}],"_postman_id":"2d6dcf2a-ebcf-42e6-9c66-5710154f0a98"},{"name":"Update Webhook (PUT)","id":"3abe5b2a-0c60-472c-97a5-75fc25c39a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/webhooks//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
follow_all_interviews	Boolean	true/false value of follow all	Optional	true/false
interviews	List[String]	Array of interviews keys; (Required if follow_all_interviews isn't True)	Optional
departments	List[String]	Array of department keys. This field can be combined with the \"interviews\" and \"users\" fields using an OR condition to filter results across multiple criteria	Optional
users	List[String]	Array of user keys. This field can be combined with the \"departments\" and \"interviews\" fields using an OR condition to filter results across multiple criteria	Optional
url	String	URL to update	Required
event	String	Size of response page	Required	new_response, status_change, new_comment, new_score
token	String	Token that will be included in \"Authorization\" header of callback	Optional	max length is 128 characters
payload_configuration[return_transcripts]	Boolean	Configuration of notification payload for answers transcript. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false
payload_configuration[return_summary]	Boolean	Configuration of notification payload for candidade summary. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false

","urlObject":{"path":["webhooks","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"be12bff6-6cf3-4cb5-b0d1-04948c6843d0","name":"Update Webhook (PUT)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"interviews\": [\"e09e51faa3d841729012a918bde1538a\"],\n \"departments\": [],\n \"users\": [],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"stage_change\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/integrations/v2/webhooks//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"a4444502dae4468a95ecc929fb2eca7e\",\n \"interviews\": [\n {\n \"key\": \"e09e51faa3d841729012a918bde1538a\",\n \"title\": \"Product Manager\"\n }\n ],\n \"departments\": [],\n \"users\": [],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"status_change\",\n \"token\": \"some-token\"\n}"}],"_postman_id":"3abe5b2a-0c60-472c-97a5-75fc25c39a13"},{"name":"Update Webhook (PATCH)","id":"430800b4-7403-4156-8a79-357e718b1c37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/webhooks//","description":"

Request body description

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

Key	Type	Description	Required	Restricted Values
follow_all_interviews	Boolean	true/false value of follow all	Optional	true/false
interviews	List[String]	Array of interviews keys; (Required if follow_all_interviews isn't True)	Optional
departments	List[String]	Array of department keys. This field can be combined with the \"interviews\" and \"users\" fields using an OR condition to filter results across multiple criteria	Optional
users	List[String]	Array of user keys. This field can be combined with the \"departments\" and \"interviews\" fields using an OR condition to filter results across multiple criteria	Optional
url	String	URL to update	Optional
event	String	Size of response page	Optional	new_response, status_change, new_comment, new_score
token	String	Token that will be included in \"Authorization\" header of callback	Optional	max length is 128 characters
payload_configuration[return_transcripts]	Boolean	Configuration of notification payload for answers transcript. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false
payload_configuration[return_summary]	Boolean	Configuration of notification payload for candidade summary. Default = false, meaning null will be returned. Please note: feature must be included on your plan to return a value. Note: Can be enabled only for new_response and status_change events.	Optional	true/false

","urlObject":{"path":["webhooks","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e9009d71-3610-4a53-a2dd-c3b07f870339","name":"Update Webhook (PATCH)","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"interviews\": [\"e09e51faa3d841729012a918bde1538a\"],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"stage_change\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/webhooks//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"key\": \"a4444502dae4468a95ecc929fb2eca7e\",\n \"interviews\": [\n {\n \"key\": \"e09e51faa3d841729012a918bde1538a\",\n \"title\": \"Product Manager\"\n }\n ],\n \"follow_all_interviews\": false,\n \"url\": \"https://your-site.com\",\n \"event\": \"status_change\",\n \"token\": \"some-token\"\n}"}],"_postman_id":"430800b4-7403-4156-8a79-357e718b1c37"},{"name":"Delete Webhook","id":"3ce67b1f-d560-479c-bf79-84d1dc145e85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/webhooks//","urlObject":{"path":["webhooks","",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e0a86e4a-3300-48ea-a330-75e14aa1b1dc","name":"Delete Webhook","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/webhooks//"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3ce67b1f-d560-479c-bf79-84d1dc145e85"}],"id":"16c38736-850e-4374-be66-3cfd91df6bda","_postman_id":"16c38736-850e-4374-be66-3cfd91df6bda","description":""},{"name":"Interview Templates","item":[{"name":"List Categories","id":"3d217c25-9d4d-45f3-82cf-1d7a7b948e8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/categories/","description":"

This request returns the list of all categories. The response is not paginated.

\n","urlObject":{"path":["categories",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bfe42f15-72ca-4323-a21a-c34e0f8fee60","name":"List categories","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/categories/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"key\": \"7b821159eaa847ffa87109692d719a38\",\n \"name\": \"Design and Product\"\n },\n {\n \"key\": \"0e03c609f7d44c0799d7d9ce76408821\",\n \"name\": \"Development\"\n },\n {\n \"key\": \"9ed28f2b64d546a2b49e62a8c9f5033e\",\n \"name\": \"IT and Software\"\n },\n {\n \"key\": \"8d87980efaab42f6be253621236d2ff9\",\n \"name\": \"Sales\"\n },\n {\n \"key\": \"79cf45dcfe9b44068ef2f32f6089e2ae\",\n \"name\": \"Engineering\"\n },\n {\n \"key\": \"8a59d628f5da4f92861d97797f8d3bd6\",\n \"name\": \"Software Engineering\"\n },\n {\n \"key\": \"c62f4b99ed344799bb968970ad41b4b2\",\n \"name\": \"Software Development\"\n }\n]"}],"_postman_id":"3d217c25-9d4d-45f3-82cf-1d7a7b948e8a"},{"name":"List Templates","id":"b9733d9c-f2b5-45a7-ba38-89cbc97f6740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interview-templates/","description":"

Query Params

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

Key	Type	Description	Required	Restricted Values
search	String	Search by title	Optional
category	String	Filter by category key	Optional
page_size	Integer	Size of response page (10 by default)	Optional	1...30
page	Integer	Page number	Optional	The requested page must exist

","urlObject":{"path":["interview-templates",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0a569354-4550-4b2e-be93-5132891cd1f0","name":"List templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base_url}}/interview-templates/?search&category&page_size&page","host":["{{base_url}}"],"path":["interview-templates",""],"query":[{"key":"search","value":null,"description":"Search by template title"},{"key":"category","value":null,"description":"Filter by category key"},{"key":"page_size","value":null,"description":"Amount of items per page, default=10"},{"key":"page","value":null,"description":"Number of the page to return"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"key\": \"c1e9aa90f4574b3fa37ce8d625c1c64b\",\n \"title\": \"Sales Assistant\",\n \"category\": {\n \"key\": \"0e03c609f7d44c0799d7d9ce76408821\",\n \"name\": \"Sales and Customer-Facing Roles\"\n },\n \"is_featured\": true,\n \"questions_count\": 5\n },\n {\n \"key\": \"a49883cdbdb842dea3c433fa1ea445ac\",\n \"title\": \"Software Engineer\",\n \"category\": {\n \"key\": \"7b821159eaa847ffa87109692d719a38\",\n \"name\": \"Technical and Specialized Skills\"\n },\n \"is_featured\": false,\n \"questions_count\": 5\n }\n ]\n}"}],"_postman_id":"b9733d9c-f2b5-45a7-ba38-89cbc97f6740"},{"name":"Get Template Details","id":"7bae3653-b4ee-44e0-89d5-b618551c1ea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interview-templates/{{template_key}}/","description":"

This request returns template details for template_key.

\n","urlObject":{"path":["interview-templates","{{template_key}}",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a3d71971-6308-4dd1-86ac-cb5ae46a3294","name":"Get template","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/interview-templates/{{template_key}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"f24f05292a394525acff52f6c51e6c7d\",\n \"title\": \"Sales Assistant Interview\",\n \"is_featured\": true,\n \"description\": \"This template is designed to help recruiters evaluate candidates for the role of Sales Assistant. The questions focus on assessing the candidate's communication skills, problem-solving abilities, customer service mindset, and adaptability to a fast-paced environment. Video and multiple-choice questions are used to assess verbal communication and decision-making skills, which are crucial for a sales role. The questions are structured to provide insights into the candidate's experience, approach to customer interactions, and their ability to contribute to team goals.\",\n \"template_description\": \"As a Sales Assistant, you will be a key part of our sales team, helping to meet and exceed sales targets. This role requires excellent communication and customer service skills. We're excited to learn more about you and your potential fit with our team. Please take your time to answer the questions thoughtfully.\",\n \"category\": {\n \"key\": \"6379ad4598cb4ceba2c20d7abf208185\",\n \"name\": \"Sales and Customer-Facing Roles\"\n },\n \"author\": {\n \"name\": \"Faith\",\n \"image\": null\n },\n \"questions\": [\n {\n \"key\": \"0a6a409180eb406ab81e347b0a968d89\",\n \"text\": \"Can you describe a time when you successfully managed a customer complaint?\",\n \"html_text\": \"

Can you describe a time when you successfully managed a customer complaint?

What do you think is the most important skill for a Sales Assistant?

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/interview-templates/{{template_key}}/interviews/","description":"

This request creates new interview based on provided template_key. If it is needed to update created interview it is possible to use Update Interview (PUT) or Update Interview (PATCH).

\n","urlObject":{"path":["interview-templates","{{template_key}}","interviews",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3b872a1e-48f3-4a2f-af90-6261f161ec60","name":"Create interview from template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"url":"{{base_url}}/interview-templates/{{template_key}}/interviews/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"key\": \"48f42349e7c84b7d9063275ad69df46d\",\n \"title\": \"Senior sales\",\n \"salary\": \"\",\n \"default_language\": null,\n \"company\": {\n \"key\": \"7fd718908e4146288a5fb92f3ef6a3fa\",\n \"name\": \"Test Company\",\n \"location\": \"France\",\n \"site\": null,\n \"layout_color\": \"\",\n \"button_color\": \"\",\n \"logo\": null,\n \"industry\": null,\n \"is_default\": true\n },\n \"video_link\": null,\n \"video_playlist_link\": null,\n \"is_own_video\": false,\n \"description\": \"

\",\n \"deadline\": null,\n \"deadline_timezone\": null,\n \"questions\": [\n {\n \"key\": \"5069863a43fd4bfea02c974adc921234\",\n \"text\": \"How are you?\",\n \"html_text\": \"

How are you?

\",\n \"order\": 1,\n \"max_duration\": 60,\n \"max_retakes\": null,\n \"answer_type\": \"audio\",\n \"thinking_time\": 0,\n \"max_characters\": 0,\n \"max_words\": 500,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {}\n },\n {\n \"key\": \"bbc733aca7064a689ad2946cffc0cc3c\",\n \"text\": \"What are you working on?\",\n \"html_text\": \"

What are you working on?

\",\n \"order\": 2,\n \"max_duration\": 60,\n \"max_retakes\": null,\n \"answer_type\": \"multiple_choice\",\n \"thinking_time\": 1200,\n \"max_characters\": 0,\n \"max_words\": 500,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"e599dbed2cc74172a0a262a2b1c993e8\",\n \"text\": \"Option 1\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"3e196517e4474a839e9f32c98f7961cf\",\n \"text\": \"Option 2\",\n \"order\": 2,\n \"is_correct\": false\n },\n {\n \"key\": \"4b423112cf4b4077b8a9d67700088c2d\",\n \"text\": \"Option 3\",\n \"order\": 3,\n \"is_correct\": true\n },\n {\n \"key\": \"1cdf1c9737f345df9585683a5254e745\",\n \"text\": \"Option 4\",\n \"order\": 4,\n \"is_correct\": false\n }\n ]\n }\n },\n {\n \"key\": \"e3c5770d53124f4a8136bcce7dd988df\",\n \"text\": \"What is the name of the role?\",\n \"html_text\": \"

What is the name of the role?

\",\n \"order\": 3,\n \"max_duration\": 60,\n \"max_retakes\": null,\n \"answer_type\": \"checkboxes\",\n \"thinking_time\": 0,\n \"max_characters\": 0,\n \"max_words\": 500,\n \"is_skip_allowed\": false,\n \"idv_country_of_employment_iso_code\": null,\n \"idv_max_checks\": null,\n \"type_specific_data\": {\n \"answer_options\": [\n {\n \"key\": \"be87e4d0c8d64d33a6567890cfba3675\",\n \"text\": \"checkbox 1\",\n \"order\": 1,\n \"is_correct\": false\n },\n {\n \"key\": \"7f09e4a7c47c4ddc9425956dcda93fe2\",\n \"text\": \"checkbox 2\",\n \"order\": 2,\n \"is_correct\": false\n },\n {\n \"key\": \"76ace6afc2a84d2e87e3d2840eaf282e\",\n \"text\": \"checkbox 3\",\n \"order\": 3,\n \"is_correct\": true\n },\n {\n \"key\": \"d136207030c5493eb041bcc350febc6d\",\n \"text\": \"checkbox 4\",\n \"order\": 4,\n \"is_correct\": false\n }\n ]\n }\n }\n ],\n \"reviewers\": [],\n \"reviewers_to_notify\": [],\n \"candidates_cnt\": 0,\n \"new_candidates_cnt\": 0,\n \"created_at\": \"2024-12-03T14:40:25.333647Z\",\n \"status\": \"draft\",\n \"rejected_cnt\": 0,\n \"accepted_cnt\": 0,\n \"invite_link\": \"https://willotalent.com\",\n \"created_by_email\": \"mariecurie@willo.video\",\n \"created_by_name\": \"Marie Curie\",\n \"show_availability_calendar\": true,\n \"show_hints\": true,\n \"redirect_url\": null,\n \"message_templates\": {\n \"invitation_email\": {\n \"title\": \"\",\n \"content\": \"\"\n },\n \"invitation_sms\": {\n \"title\": \"\",\n \"content\": \"\"\n },\n \"reminder_email\": {\n \"title\": \"\",\n \"content\": \"\"\n },\n \"reminder_sms\": {\n \"title\": \"\",\n \"content\": \"\"\n },\n \"interview_completed_email\": {\n \"title\": \"\",\n \"content\": \"\"\n }\n },\n \"draft_data\": {},\n \"scorecard\": null\n}"}],"_postman_id":"e1c988f2-667f-4690-a68c-6bba7135803d"}],"id":"17c2708f-2739-42cc-b062-52560ca9b4b6","_postman_id":"17c2708f-2739-42cc-b062-52560ca9b4b6","description":""},{"name":"Child Organisations","item":[{"name":"Create Child Organisation","id":"83a51bbb-f459-4070-961a-52ff8da1f067","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/children/","description":"

Create a new child organisation under the parent organisation.
Request body description

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

Key	Type	Description	Required
customer_full_name	String	Full Name of the Child Organisation owner	Required
customer_email	String	Email Address of the Child Organisation owner	Required
organisation_name	String	Name of the Child Organisation	Required

","urlObject":{"path":["children",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d0ab531d-413d-4e1e-9237-388379a3e328","name":"Create Child Organisation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"","description":"Integration key available in Integrations page of Willo","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer_full_name\": \"John Doe\",\n \"customer_email\": \"john@doe.com\",\n \"organisation_name\": \"John Doe Technologies\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/children/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"key\": \"d940008ce74f47ecafdd3d3bb0b6c4a7\",\n \"name\": \"John Doe Technologies\",\n \"verification_status\": \"verified\",\n \"owner\": {\n \"key\": \"ab67b126c00a435ab2bc933f7d428fef\",\n \"full_name\": \"John Doe\",\n \"email\": \"john@doe.com\"\n },\n \"user_relations\": [\n {\n \"key\": \"1bda9acf65ae4be4bd1256c84ec923cc\",\n \"user\": {\n \"key\": \"ab67b126c00a435ab2bc933f7d428fef\",\n \"full_name\": \"John Doe\",\n \"email\": \"john@doe.com\"\n },\n \"role\": \"admin\",\n \"status\": \"joined\"\n }\n ]\n}"}],"_postman_id":"83a51bbb-f459-4070-961a-52ff8da1f067"},{"name":"List Children","id":"3b4f9877-c801-43c8-93ca-67d673d00ef8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","description":"

Integration key available in Integrations page of Willo

\n","type":"text"}],"url":"{{base_url}}/children/","description":"

Retrieve a list of all child organisations under the parent organisation.

\n","urlObject":{"path":["children",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ee1068d3-4d93-4092-b918-cc2a41e9f37e","name":"List Children","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","description":"Integration key available in Integrations page of Willo","type":"text"}],"url":"{{base_url}}/children/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"key\": \"d940008ce74f47ecafdd3d3bb0b6c4a7\",\n \"name\": \"John Doe Technologies\",\n \"verification_status\": \"verified\",\n \"owner\": {\n \"key\": \"ab67b126c00a435ab2bc933f7d428fef\",\n \"full_name\": \"John Doe\",\n \"email\": \"john@doe.com\"\n },\n \"user_relations\": [\n {\n \"key\": \"1bda9acf65ae4be4bd1256c84ec923cc\",\n \"user\": {\n \"key\": \"ab67b126c00a435ab2bc933f7d428fef\",\n \"full_name\": \"John Doe\",\n \"email\": \"john@doe.com\"\n },\n \"role\": \"admin\",\n \"status\": \"joined\"\n }\n ]\n }\n]"}],"_postman_id":"3b4f9877-c801-43c8-93ca-67d673d00ef8"}],"id":"bfdab3bb-8565-4f55-a3a5-30ce3a5ac6fd","description":"

The Child–Parent API allows a parent organisation to create and manage child organisations under its umbrella. Using a secure key, the parent can act on behalf of a child organisation—accessing the same endpoints with the child’s permissions—without needing separate logins or workflows. This streamlines administration, centralises control, and simplifies management for organisations that oversee multiple entities.

For example, if you are an ATS vendor, the Child–Parent API lets you manage all your client agencies under one roof. Each agency gets its own isolated account, while you can act on their behalf through a single integration—posting jobs, pulling candidates, and syncing data without duplicate setup. It means faster onboarding, less maintenance, and cleaner control across your network.

This set of APIs allows you to create, list, and manage child organisations under a parent organisation’s umbrella.

When an organisation becomes a parent, it can perform other API requests on behalf of its child by including the X-Agency-User-Key header in addition to the standard authorization header. This key represents the relationship of a specific user to the child organisation. Using it, the parent can access the same endpoints with the permissions of the selected user.

The X-Agency-User-Key can be obtained either from the response body when creating a child organisation, or from the list endpoint under the user_relations section (key value).

⚠️ Access to these APIs is restricted
You must be authorised by Willo team. If you’d like to use these endpoints, please contact our support team to become an authorised partner.

\n","_postman_id":"bfdab3bb-8565-4f55-a3a5-30ce3a5ac6fd"}]}