{"info":{"_postman_id":"57964834-3b94-405f-ab5f-adb49dc3ad49","name":"Verse External API","description":"

Overview

Verse's external API offers robust functionality for conversation (Lead) management and webhook subscriptions, enabling seamless integration with your existing workflows. The API supports creating Conversations (leads) via a POST method and subscribing to multiple webhook activity types to receive updates about Verse's engagement with your leads. These activity types provide varying levels of detail about interactions within a Conversation.

Getting Started

For Conversation (Lead) Creation Only

If your primary goal is to send Conversations to Verse without requiring updates, you can proceed directly to the Create Lead POST section. This will cover all the necessary steps to perform that action.

For Conversation (Lead) Updates via Webhooks

If you aim to send Conversations (leads) and also receive updates on Conversation (lead) activity, you’ll need to review the Webhooks folder.

Work with your Account Manager to set up customized scripting. While this document provides sample configurations \"For Position Only,\" the field names in the payloads will remain consistent, but the data will be tailored to your specific needs. Scripts are custom-built for your organization, ensuring they align with your business use cases.

Managing Conversations

Use Case: Ending Conversations

Do you anticipate needing to stop Verse from engaging with a Customer because your team has already connected with them? If so, consider the End Conversation and Stop Conversation endpoints:

End Conversation: Marks the Conversation as Qualified.
\n
Stop Conversation: Marks the Conversation as Unqualified.
\n
DNC (Opt-Out): Marks the Conversation as Unqualified and adds the Customer to your Do Not Contact List within Verse to prevent future engagement.
\n

Deciding between these endpoints depends on whether you want the Conversation to be categorized as qualified or unqualified when halting Verse’s engagement.

Account and Subscription Management

Single vs. Multiple Accounts

The API key you use determines the account or system where actions are performed. If you manage multiple accounts, consider the following:

Use the Primary API Key for a team subscription to receive webhook events for all team members.
\n
Alternatively, create individual subscriptions for each team member if you need events routed to unique URLs.
\n

Use Case:

Subscribe to all events at a team level for centralized updates.
\n
Route events for sub-accounts or individual team members to their respective URLs for distributed updates.
\n

Conclusion

Once you've determined your use case and integration needs, you can begin leveraging the Verse API and webhooks to optimize your Conversation (lead) management process. For further assistance, consult your Account Manager or refer to the detailed sections in this document.

Notable Changes

Historically the individual \"Conversations\" were referred to as \"Leads\" hence many of the end points referencing the word \"lead\". As we've grown however lead doesn't adequately capture the type of engagement that is performed by Verse.

This documentation has thus been changed to reference \"Customers\" And \"Conversations\", where a Customer is the individual we engage with, however we may engage with a Customer over many conversations (leads). Please note that future versions of the external API will be updated to reflect this change, however the current API will still reference \"Leads\" in its endpoints and webhook activities.

Error Codes

The following HTTP response codes are used to determine the status of an API request.

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

Code	Message Response	Explanation
200	{\"status\": \"success\"}	Your API request was successful
201	{\"message\": \"Created Lead\", \"id\": \"1234567890\"}	Successful request, Conversation (lead) was created as expected
201	{\"message\": \"Created lead, but phone is invalid, and no email was provided\", \"id\": \"1234567890\"}	Successful request, Conversation (Lead) was created however the phone provided was not valid and no email address was provided
201	{\"message\": \"Created lead, but phone was previously blacklisted\", \"id\": \"1234567890\"}	Successful request, Conversation (lead) was created, however the phone number provided is on your blacklist.
201	{\"message\": \"Created lead, but phone is invalid, email was valid\", \"id\": \"1234567890\"}	Successful request, Conversation (lead) was created, however the phone was invalid but the email was valid.
201	{\"message\": \"Created lead, but email is invalid, phone was valid\", \"id\": \"1234567890\"}	Successful request, Conversation (lead) was created, however the email was invalid but the phone was valid.
401	{\"message\": \"Unauthorized\"}	Missing or invalid authentication key/token
403	{\"message\": \"Missing Authentication Token\"}	Your update action was attempted successfully, however the Conversation (lead) was not found.
404	{\"message\": \"Resource Not Found\"}	You attempted to perform an action on a Conversation (lead) that was not found.
409	{\"message\": \"Duplicate Lead\"}	Requested conflicts with another request, duplicate Conversation (lead), is still active.
422	{\"message\": \"Your account is not set up to receive leads at this time. If you would like to make a change, please contact your account manager. \"}	Your account is set up to reject Convesations (leads) during a certain period of the day. Verse will reject Conversations (leads) that are sent to us during this time frame. If you would like to update this time, please contact your account manager.
422	{\"message\": \"Your account is currently on hold. Please contact your account manager if you would like to reactivate.\"}	Your account is currently on hold, and is not accepting new Conversations (leads). If you'd like to activate your account again, please contact your account manager.
422	{\"message\": \"phone is invalid\"}	The phone number is invalid and the Conversation (lead) was not created.
422	{\"message\": \"Invalid request body\"}	The JSON provided is not valid, please check your data and try again.
422	{\"message\": \"\"phone\" is required\"}	This may be phone, or email, the Conversation (lead) was not created.
500	{\"message\": \"Something went wrong. If this error continues, please contact your account manager.\"}	Verse server error

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Error Codes","slug":"error-codes"}],"owner":"14869652","collectionId":"57964834-3b94-405f-ab5f-adb49dc3ad49","publishedId":"TzCL9UNR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-01T22:48:56.000Z"},"item":[{"name":"Webhooks","item":[{"name":"Create New Webook","id":"19dfac6c-7b0f-41a7-943a-097a64fc482c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_activity\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook","description":"

Create Webhook Subscription Endpoint

The \"Create Webhook Subscription\" endpoint enables you to subscribe to events either at the team level or at the individual sub account level. Webhooks allow real-time notifications to be sent to a specified URL when subscribed events occur.

Key Features

Team-Level vs Individual-Level Subscriptions

Team-Level Subscriptions: To subscribe at the team level, include the optional field teamLevel set to true. This option requires the use of an Admin API key. If attempted with a non-Admin API key, a 404 response will be returned.
\n
Individual-Level Subscriptions: If subscribing to an individual team member's event, omit the teamLevel field from the request.
\n

Event Field

The event field specifies the type of event to subscribe to. Use values from the events table to define this field.

Customizable Headers

The headers array allows customization based on the authentication requirements of the receiving URL.
\n
Note: Dynamic authentication is not supported for webhook subscriptions at this time.
\n

URL Field

The url field specifies the destination URL where event notifications will be sent.

Required Headers for Webhook Subscription

Include the following headers in your subscription request:

\"X-API-KEY\": \"\"
\n
\"Content-Type\": \"application/json\"\"Connection\": \"keep-alive\"
\n

Example Use Cases

Subscribe to team-level events such as Conversation (lead) creation or updates.
\n
Create individual-level subscriptions for specific team members' activities.
\n
Integrate webhook subscriptions with custom URLs requiring specific authentication headers.
\n

Process

Define the subscription level (teamLevel or individual) in your request payload.
\n
Specify the event, url, and any required headers.
\n
Submit the request using the required authentication and headers.
\n

For additional details or technical support, refer to the API documentation or contact your Account Executive.

\n","urlObject":{"protocol":"https","path":["v1","webhook"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"1a69c3b7-e3ba-4dbd-b987-16b3242a5f56","name":"New Request - Team Level - 403","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_created\",\n \"teamLevel\": true,\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\\\"teamLevel\\\" is not allowed\"\n}"},{"id":"7fd5b385-ce5b-496b-86f4-ce07c54a8789","name":"Create New Webook - Lead Created - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_created\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhookId\": 5175\n}"},{"id":"7cc1221e-61de-4e18-a73b-77efbe8e51ea","name":"Create New Webook - Failed - Invalid Event Name","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_deleted\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\\\"event\\\" must be one of [lead_created, lead_activity, lead_qualify, lead_unqualify, lead_take_over]\"\n}"},{"id":"4a1b256f-6370-49a5-9da3-0ddb4a52d92f","name":"Create New Webook - Lead Qualify","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_qualify\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhookId\": 5176\n}"},{"id":"003c1313-a2c0-4f99-9cb0-fd999d05d4b2","name":"Create New Webook - Conversation Take Over","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_take_over\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhookId\": 5176\n}"},{"id":"35c02845-ec58-4580-acc0-bb262be40cf0","name":"Create New Webook - Lead Activity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\": \"lead_activity\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n }\n}"},"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhookId\": 5177\n}"}],"_postman_id":"19dfac6c-7b0f-41a7-943a-097a64fc482c"},{"name":"Get Created Webooks (All or Agent Specific)","id":"acb9c5d4-54f6-45f9-aee9-7178b32b723e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"}],"url":"https://api.verse.io/v1/webhook","urlObject":{"protocol":"https","path":["v1","webhook"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"a736e38d-f1bf-45f3-bce7-d221f47fc236","name":"Get All Webhook Subscriptions - Team Level","originalRequest":{"method":"GET","header":[],"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhooks\": [\n {\n \"id\": 5169,\n \"event\": \"lead_created\",\n \"url\": \"https://hooks.zapier.com/hooks/catch/11518581/bgh7rkc/\",\n \"headers\": null,\n \"teamLevel\": false,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n },\n {\n \"id\": 5170,\n \"event\": \"lead_activity\",\n \"url\": \"https://hooks.zapier.com/hooks/catch/11518581/bgh7rkc/\",\n \"headers\": null,\n \"teamLevel\": false,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n },\n {\n \"id\": 5171,\n \"event\": \"lead_qualify\",\n \"url\": \"https://hooks.zapier.com/hooks/catch/11518581/bgh7rkc/\",\n \"headers\": null,\n \"teamLevel\": false,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n },\n {\n \"id\": 5172,\n \"event\": \"lead_unqualify\",\n \"url\": \"https://hooks.zapier.com/hooks/catch/11518581/bgh7rkc/\",\n \"headers\": null,\n \"teamLevel\": false,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n },\n {\n \"id\": 5173,\n \"event\": \"lead_activity\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n },\n \"teamLevel\": true,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n }\n ]\n}"},{"id":"91322067-03c3-458d-b445-13866cacb623","name":"Get Webook - Error - Missing API key","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"","type":"text"}],"url":"https://api.verse.io/v1/webhook"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"missing X-API-KEY header\"\n}"},{"id":"eeb2055c-d390-43f0-8316-9b6f1ca4277c","name":"Get User Specific Webhook Subscriptions","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"661d5811-51fe-11ec-a074-0a96281e0c6f","type":"text"}],"url":"https://api.verse.io/v1/webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"webhooks\": [\n {\n \"id\": 5174,\n \"event\": \"lead_activity\",\n \"url\": \"http://localhost/created\",\n \"headers\": {\n \"x-test3\": \"test\"\n },\n \"teamLevel\": false,\n \"userId\": \"f528c2f3-a660-4768-a08e-fbd785187396\"\n }\n ]\n}"}],"_postman_id":"acb9c5d4-54f6-45f9-aee9-7178b32b723e"},{"name":"Delete Webhook Subscriptions","id":"4b9d0d3a-8481-4bb3-bd3e-edb5c5ebd751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-API-KEY","value":"","type":"text"}],"url":"https://api.verse.io/v1/webhook/ ","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"cd68dfbf-6fdf-4b51-9b58-ae3df7fe0644","id":"cd68dfbf-6fdf-4b51-9b58-ae3df7fe0644","name":"Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["v1","webhook"," "],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b9d0d3a-8481-4bb3-bd3e-edb5c5ebd751"}],"id":"cd68dfbf-6fdf-4b51-9b58-ae3df7fe0644","description":"\n

Webhooks enable real-time notifications by sending event-related data to a specified URL when subscribed activities occur. This overview explains how to subscribe to webhooks and outlines the available events, activity types, and field descriptions.

\n\n

Webhooks can be subscribed to at the team level or individual level, depending on your requirements:

Team-Level Subscriptions: Include the optional field teamLevel set to true when subscribing. Note that this requires an Admin API key. If a non-Admin API key is used, a 404 response will be returned.
\n
Individual-Level Subscriptions: Omit the teamLevel field to subscribe to an individual team member’s events.
\n

When subscribing, you can choose to receive team members' activities as separate webhooks or consolidate all activities into a single webhook. Please coordinate with your Account Executive to configure your desired setup.

Available Event Types

lead_activity: Triggered for all Conversation (lead)-related activity, including notes, messages, calls, emails, and (un)qualification.
\n
lead_created: Triggered when a Conversation (lead) is created. Useful for notifications about Conversations (leads) that may have been started without first being sent to your CRM.
\n
lead_qualify: Triggered when a Conversation (lead) is qualified. Includes all custom question responses.
\n
lead_unqualify: Triggered when a Conversation (lead) is unqualified. Includes custom question responses and the reason for unqualification.
\n
lead_take_over: Triggered when a Conversation (lead) has been taken over by a user in the customer portal.
\n

Verse Activity Types \"title\"

The title field in the webhook payload corresponds to the activity type. Below is a list of activity types and their descriptions:

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

Verse Activity (title)	Description
Lead Created	Sent when a new Conversation (lead) is created (subscribed via `lead_created`).
Lead Updated	Sent when a Conversation's (lead's) details are updated (subscribed via `lead_activity`).
Qualified Lead	Sent when a Conversation (lead) is qualified (subscribed via `lead_activity` or `lead_qualify`).
Unqualified Lead	Sent when a Conversation (lead) is unqualified (subscribed via `lead_activity` or `lead_unqualify`).
Inbound SMS	Sent when an inbound SMS is received on a Conversation (lead) (subscribed via `lead_activity`).
Outbound SMS	Sent when an outbound SMS is sent in a Conversation (lead) (subscribed via `lead_activity`).
Concierge Note	Sent when the Concierge adds a note for a Conversation (lead) (subscribed via `lead_activity`).
Outbound Email	Sent when an outbound email is sent in a Conversation (lead) (subscribed via `lead_activity`).
Inbound Email	Sent when an inbound email is received in a Conversation (lead) (subscribed via `lead_activity`).
Outbound Call Attempt	Sent when an outbound call in a Conversation (lead) is attempted (subscribed via `lead_activity`).
Inbound Call Received	Sent when an inbound call in a Conversation (lead) is received (subscribed via `lead_activity`).
Live Transfer Attempt	Sent when a live transfer is attempted (subscribed via `lead_activity`).
Live Transfer Successful	Sent when a live transfer is successful (subscribed via `lead_activity`).
Live Transfer Unsuccessful	Sent when a live transfer is unsuccessful (subscribed via `lead_activity`).
Conversation Taken Over	Sent when a team member has taken over the conversation.

Field Descriptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Label	Type	Description
channelWebsite	Lead Channel Website	string	This is the \"Source\" of the Conversation (lead) which can be used to track effecicay of specific advertising campaigns.
city	Lead City	string	This is the city of the Customer; for Real Estate this will be used as the city of the property the Customer is interested in for this specific Conversation (lead).
email	Lead Email	string	This is the email address of the Customer that will be used to engage the Customer via email in the Conversation (lead)
externalLeadID	External Lead Id	[\"string\", null],	This is YOUR Conversation (lead) id which will be correspond to the \"externalLeadId\" when Verse sends data back regarding your Conversation (lead).
firstName	Lead First Name	string	This is the first name of the Customer for this specific Conversation (lead)
id	Lead Id	string	This is the Verse ID of the Conversation (lead)
lastName	Lead Last Name	string	This is the last name of the Customer for this specific Conversation (lead)
leadComment	Lead Comment	string	this is the the comments from our Verse Concierge Team regarding the Conversation (lead) and its details
leadType	Lead Type	string	This is the Type of Conversation (lead): For Real Estate: \"buyer\" or \"seller. For Mortgage: \"mortgage\" for purchase or \"refi\" for refinance All other industries can pass any value.
link	lead Link	string	This is a direct URL to the Conversation's (lead's) details in your Verse account.
message	Message of the webhook - dynamic	string	This is the details of the activity that occurred - can include the content of the inbound / outbound SMS message.
eventDate	Date and time the event occurred in yyyy-mm-dd hh:mm:ss in military time. This time is in UTC
lastCommunicationChannel	This is the last method of communication used to engage with the lead, can be \"sms\", \"call\", \"email\".
postalCode	Lead Postal Code	string	This is the postal code of the Customer; for Real Estate this will be used as the state of the property that the customer is interested in for this specific Conversation (lead).
state	Lead State	string	This is the state of the Customer; for Real Estate this will be used as the state of the property the Customer is interested in for this specific Conversation (lead).
street	Lead Street Address	string	This is the street address of the Customer; for Real Estate this will be used as the street address of the property that the Customer is interested in for this specific Conversation (lead).
scriptId	Script ID	string	This is an optional field that when included in an API payload submission will override the default script that is used to engage newly created Conversations (leads). This field can only be used in the create Conversation (lead) post action. To understand what available Script IDs can be used during the Conversation (lead) creation, use the Get scripts endpoint.
reasonUnqualified	Lead Reason Unqualified	string	'{reasonUnqualified} is dynamic and only is applied to lead_unqualify and lead_activity when the Conversation (lead) is unqualified'
customQuestions	Custom Questions	objectstring:string	This field contains all of the custom questions and their responses in your script.
customerFields	Custom Fields	objectstring:string	This field contains the custom field values that were sent over with this Conversation (lead).
owner	Dynamic Owner	objectstring:string	This is only sent if there is a dynamic owner
successfulCallConnectTransfer	Identifier for Successful Call Connect Transfers, true or false	true/false	This will only be specified if a callconnect transfer has been attempted: If the call was successfully transferred (your call center picked up) it will be marked as True. If the call was not successfully transferred (either your team didn't pick up, or the Customer hung up before being successfully transferred), we mark it as false. If the Conversation (lead) was previously marked as successfulCallConnectTransfer false, and we then successfully transfer it to your team, we will mark it as true. If the Conversation (lead) was previously marked as successfulCallConnectTransfer true, and for whatever reason an additional attempt is made, but not successfully transferred, we leave it marked as true.
title	Verse Type	See Verse Activity Types	This field is the name of the activity that triggered the webhook.
event	Verse Event	See Verse Event Types	This field is the name of the webhook you subscribed to.
userID	Verse User ID	string	This is the Verse Sub Account ID that the Conversation (lead) was created in.

#Sample 1 - New Qualified Lead Event With Owner Fields \n{\n  \"event\": \"lead_qualify\",\n  \"title\": \"Qualified Lead\",\n  \"eventDate\": \"2022-04-22 23:12:12\",\n  \"message\": \"We've qualified a new lead for you! Communication Preference: Text\\nInterested in a new customized Aston Martin?: Yes\",\n  \"customQuestions\": {\n    \"Communication Preference\": \"Text\",\n    \"Interested in a new customized Aston Martin?\": \"Yes\"\n  },\n  \"channelWebsite\": \"MI-6\",\n  \"city\": \"London\",\n  \"email\": \"jamesbond@test.com\",\n  \"externalLeadId\": \"007\",\n  \"firstName\": \"James\",\n  \"id\": \"12345678-a123-aabb-12ab-abc123245678\",\n  \"lastName\": \"Bond\",\n  \"leadComment\": \"Communication Preference: Text\\nInterested in a new customized Aston Martin?: Yes\",\n  \"leadType\": \"buyer\",\n  \"link\": \"https://app.verse.io/leads/12345678-a123-aabb-12ab-abc123245678\",\n  \"phone\": \"+17401235555\",\n  \"phoneCarrierType\": \"mobile\",\n  \"postalCode\": \"43140\",\n  \"state\": \"OH\",\n  \"street\": null,\n  \"customFields\": {},\n  \"owner\": {\n       \"email\": \"q@zmail.com\",\n       \"phone\": \"+17401235555\",\n       \"calendly\": \"https://quartermaster.com/calendar-link\",\n       \"lastName\": \"Boothroyd\",\n       \"firstName\": \"Major\",\n       \"personaTeamName\": \"MI-6\",\n       \"notificationEmail\": \"q@zmail.com\",\n       \"notificationPhone\": \"+17401235555\",\n       \"callForwardingNumber\": \"+17401235555\",\n       \"callCenterRoutingNumber\": \"+17405555555\"\n  },\n  \"additionalNote\": null,\n  \"lastCommunicationChannel\": \"sms\",\n  \"userId\": \"mi6qmpjb-kfbr-392k-fbr3-92kfbr392kf\"\n}\n\n

#Sample 2 - New Unqualified Lead Event\n{\n  \"event\": \"lead_unqualify\",\n  \"title\": \"Unqualified Lead\",\n  \"eventDate\": \"2022-04-23 23:12:12\",\n  \"message\": \"We've Unqualified this lead for the following reason: Stop Contact | This lead has opted out of SMS communication.\",\n  \"reasonUnqualified\": \"Stop Contact\",\n  \"customQuestions\": {},\n  \"channelWebsite\": \"MI-6\",\n  \"city\": \"London\",\n  \"email\": \"jamesbond@test.com\",\n  \"externalLeadId\": \"007\",\n  \"firstName\": \"James\",\n  \"id\": \"12345678-a123-aabb-12ab-abc123245678\",\n  \"lastName\": \"Bond\",\n  \"leadComment\": \"This lead has opted out of SMS communication.\",\n  \"leadType\": \"buyer\",\n  \"link\": \"https://app.verse.io/leads/12345678-a123-aabb-12ab-abc123245678\",\n  \"phone\": \"+17401235555\",\n  \"phoneCarrierType\": \"mobile\",\n  \"postalCode\": \"43140\",\n  \"state\": \"OH\",\n  \"street\": null,\n  \"customFields\": {},\n  \"owner\": null,\n  \"additionalNote\": null,\n  \"lastCommunicationChannel\": \"sms\",\n  \"userId\": \"mi6qmpjb-kfbr-392k-fbr3-92kfbr392kf\"\n}\n\n

#Sample 3 - New Lead Activity Event\n{\n  \"event\": \"lead_activity\",\n  \"title\": \"Outbound SMS\",\n  \"eventDate\": \"2022-04-21 23:12:12\",\n  \"message\": \"Outbound SMS: Still interested in learning more?\",\n  \"customQuestions\": {},\n  \"channelWebsite\": \"MI-6\",\n  \"city\": \"London\",\n  \"email\": \"jamesbond@test.com\",\n  \"externalLeadId\": \"007\",\n  \"firstName\": \"James\",\n  \"id\": \"12345678-a123-aabb-12ab-abc123245678\",\n  \"lastName\": \"Bond\",\n  \"leadComment\": null,\n  \"leadType\": \"buyer\",\n  \"link\": \"https://app.verse.io/leads/12345678-a123-aabb-12ab-abc123245678\",\n  \"phone\": \"+17401235555\",\n  \"phoneCarrierType\": \"mobile\",\n  \"postalCode\": \"43140\",\n  \"state\": \"OH\",\n  \"street\": null,\n  \"customFields\": {},\n  \"owner\": null,\n  \"additionalNote\": null,\n  \"lastCommunicationChannel\": \"sms\",\n  \"userId\": \"mi6qmpjb-kfbr-392k-fbr3-92kfbr392kf\"\n}\n\n

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"98a61fe4-eb2a-45af-8c6c-2d7e5e97307b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5c808e3c-ec13-4240-9d7b-1ec4fc93a8c2","type":"text/javascript","exec":[""]}}],"_postman_id":"cd68dfbf-6fdf-4b51-9b58-ae3df7fe0644"},{"name":"Create Conversation","id":"4634d6dc-4f8a-4c1a-8d14-dae89c3c3b10","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Buzz\",\n \"lastName\": \"Aldrin\",\n \"email\": \"matthew@verse.io\",\n \"phoneNumber\": \"612-555-5555\",\n \"type\": \"Solar\",\n \"street\": \"101 West Broadway\",\n \"city\": \"San Diego\",\n \"state\": \"CA\",\n \"postalCode\": \"92101\",\n \"leadComment\": \"Example Lead Comment\",\n \"channelWebsite\": \"Verse\",\n \"externalLeadId\": \"f30d896a-1317-4814-88ca-ff71c40bead\",\n \"owner.firstName\": \"James\",\n \"owner.lastName\": \"Bond\",\n \"owner.email\": \"007@verse.io\",\n \"owner.phone\": \"555-555-555\",\n \"owner.calendly\": \"https://calendly.com/verse007\",\n \"owner.teamName\": \"007\",\n \"customFields\": { \n \"custom\" : \"example\",\n \"box\" : \"feeder\"}\n}"},"url":"https://api.verse.io/v1/zapier","description":"

Field Details

Field Name	Field Example	Type	Description
channelWebsite	Verse	string	This is the \"Source\" of the Conversation (lead) which can be used to track efficacy of specific advertising campaigns.
city	San Diego	string	This is the city of the Customer (lead); for Real Estate this will be used as the city of the property the Customer is interested in for this specific Conversation (lead).
customFields	{ \"electricityBill\" : \"100\", \"neighborhood\" : \"Alaska\" }	object \"string\":\"string\"	This field is used to create a single or multiple custom fields that can be used in Verse's Campaigns.
email	buzzaldrin@verse.io	string	This is the email address of the Customer (lead) that will be used to engage with the Customer via email.
firstName	Buzz	string	This is the first name of the Customer (lead).
lastName	Aldrin	string	This is the last name of the Customer (lead).
leadComment	Example Lead Comment	string	This field is planning to be deprecated and is no longer in regular use.
additionalNote	Example Additional Note	string	This field is to provide additional notes to the Concierge team regarding the Conversation (lead).
phoneNumber	619-123-4567	string	This is the phone number of the Customer (lead) that will be used to engage in a Conversation (lead) via sms and Must be unique.
postalCode	92101	string	This is the postal code of the Customer (lead); for Real Estate this will be used as the state of the property of the Customer is interested in for this specific Conversation (lead).
scriptId	Script ID	string	This is an optional field that when included in an API payload submission will override the default script that is used to engage newly created Conversations (leads). This field can only be used in the create Conversation (lead) post action. To understand what available Script IDs can be used during the Conversation (lead) creation, use the Get scripts endpoint.
street	101 West Broadway	string	This is the street address of the Customer; for Real Estate this will be used as the street address of the property the Customer is interested in for this specific Conversation (lead).
state	CA	string	This is the state of the Customer; for Real Estate this will be used as the state of the property the Customer is interested in for this specific Conversation (lead).
type	buyer	string	This is the Type of Conversation (lead): For Real Estate: \"buyer\" or \"seller. For Mortgage: \"mortgage\" for purchase or \"refi\" for refinance All other industries can pass any value.
externalLeadId	f30d896a-1317-4814-88ca-ff71c40bead	string	This is YOUR Conversation (lead) id which will correspond to the \"externalLeadId\" when Verse sends data back regarding your Conversation (lead).
owner.calendly	https://calendly.com/verse007	string	This field will override the default appointment booking link used when booking an appointment for this specific Conversation (lead).
owner.email	007@verse.io	string	This field will override the default email address that is notified when this specific Conversation (lead) is qualified or unqualified.
owner.firstName	James	string	This field will override the default first name that is used in Verse's campaigns for this specific Conversation (lead).
owner.lastName	Bond	string	This field will override the default last name that is used in Verse's campaigns for this specific Conversation (lead).
owner.phone	700-070-0707	string	This field will override the default phone number that is used in live transferring this specific Conversation (lead).
owner.teamName	007	string	This field will override the default Team name that is used in Verse's campaigns.
owner.callCenterRoutingNumber	1234567890	string	This field will override the default CallConnect number that a Customer is connected to for Callconnect accounts for this Conversation (lead) only.

NOTE: If the phoneNumber is not a valid number, Verse's systems will remove the phone number and continue working the Conversation (lead) as an email only campaign.

\n","urlObject":{"protocol":"https","path":["v1","zapier"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"df8904ca-567d-4da8-8e46-edc2f8feb8b5","name":"200 OK RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Buzz\",\r\n \"lastName\": \"Aldrin\",\r\n \"email\": \"buzzaldrin@verse.io\",\r\n \"phoneNumber\": \"619-123-4567\",\r\n \"type\": \"buyer\",\r\n \"street\": \"101 West Broadway\",\r\n \"city\": \"San Diego\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"92101\",\r\n \"leadComment\": \"Example Lead Comment\",\r\n \"channelWebsite\": \"Verse\",\r\n \"externalLeadId\": \"f30d896a-1317-4814-88ca-ff71c40bead\",\r\n \"owner.firstName\": \"James\",\r\n \"owner.lastName\": \"Bond\",\r\n \"owner.email\": \"007@verse.io\",\r\n \"owner.phone\": \"700-070-0707\",\r\n \"owner.calendly\": \"https://calendly.com/verse007\",\r\n \"agent.teamName\": \"007\",\r\n \"customFields\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"cfdc10f0-f7ae-49f6-8343-b651f4620cbc\"\r\n}"},{"id":"df3b1d65-d117-4d7e-bb8f-503c853835b1","name":"Create New Lead - Duplicate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"Buzz\",\n \"lastName\": \"Aldrin\",\n \"email\": \"buzzaldrin@verse.io\",\n \"phoneNumber\": \"612-322-1173\",\n \"type\": \"Solar\",\n \"street\": \"101 West Broadway\",\n \"city\": \"San Diego\",\n \"state\": \"CA\",\n \"postalCode\": \"92101\",\n \"leadComment\": \"Example Lead Comment\",\n \"channelWebsite\": \"Verse\",\n \"externalLeadId\": \"f30d896a-1317-4814-88ca-ff71c40bead\",\n \"owner.firstName\": \"James\",\n \"owner.lastName\": \"Bond\",\n \"owner.email\": \"007@verse.io\",\n \"owner.phone\": \"555-555-5555\",\n \"owner.calendly\": \"https://calendly.com/verse007\",\n \"owner.teamName\": \"007\",\n \"customFields\": { \n \"custom\" : \"example\",\n \"box\" : \"feeder\"}\n}"},"url":"https://api.verse.io/v1/zapier"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": {\n \"code\": 409,\n \"message\": \"Conflict\"\n },\n \"code\": 110,\n \"message\": \"Duplicate\"\n}"}],"_postman_id":"4634d6dc-4f8a-4c1a-8d14-dae89c3c3b10"},{"name":"Update Conversation","id":"713d4ac0-e485-4a39-8b03-886acfeb8e24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\": \"619-123-4567\",\r\n \"firstName\": \"Buzz\",\r\n \"lastName\": \"Aldrin\",\r\n \"type\": \"testing123\",\r\n \"email\": \"buzzaldrin@verse.io\",\r\n \"street\": \"101 West Broadway\",\r\n \"city\": \"San Diego\",\r\n \"state\": \"CA\",\r\n \"postalCode\": \"92101\",\r\n \"externalLeadId\": \"f30d896a-1317-4814-88ca-ff71c40bead\",\r\n \"leadConverted\" : true,\r\n \"leadConversionAmount\" : 1234,\r\n \"agent.firstName\": \"James\",\r\n \"agent.lastName\": \"Bond\",\r\n \"agent.email\": \"007@verse.io\",\r\n \"agent.phone\": \"700-070-0707\",\r\n \"agent.calendly\": \"https://calendly.com/verse007\",\r\n \"agent.callCenterRoutingNumber\" : \"619-123-4567\"\r\n}"},"url":"https://api.verse.io/v1/zapier/lead","description":"

Field Details

Field Name	Field Example	Type	Description
city	San Diego	string	This is the city of the Customer; for Real Estate this will be used as the city of the property the Customer is interested in for this specific Conversation (lead).
searchValue	619-123-4576	string	This field depends on the phone or leadId specified in order to return the desired result.
email	buzzaldrin@verse.io	string	This is the email address of the Customer that will be used to engage with the Customer via email.
type	example	string	This is used to update the Conversation Type
customFields	{ \"electricityBill\" : \"100\", \"neighborhood\" : \"Alaska\" }	object \"string\":\"string\"	This field is used to create a single or multiple custom fields that can be used in Verse's Campaigns. This will update existing customFields or add to the existing customFields.
firstName	Buzz	string	This is the first name of the Customer.
lastName	Aldrin	string	This is the last name of the Customer.
postalCode	92101	string	This is the postal code of the Customer; for Real Estate this will be used as the state of the property the Customer is interested in for this specific Conversation (lead).
street	101 West Broadway	string	This is the street address of the Customer; for Real Estate this will be used as the street address of the property the Customer is interested in for this specific Conversation (lead).
state	CA	string	This is the state of the Customer; for Real Estate this will be used as the state of the property the Customer is interested in for this specific Conversation (lead).
externalLeadId	f30d896a-1317-4814-88ca-ff71c40bead	string	This is YOUR Conversation (lead) id which will correspond to the \"externalLeadId\" when Verse sends data back regarding your Customer.
owner.calendly	https://calendly.com/verse007	string	This field will override the default appointment booking link used when booking an appointment for this specific Conversation (lead).
owner.email	007@verse.io	string	This field will override the default email address that is notified when this specific Conversation (lead) is qualified or unqualified.
owner.firstName	James	string	This field will override the default first name that is used in Verse's campaigns for this specific Conversation (lead).
owner.lastName	Bond	string	This field will override the default last name that is used in Verse's campaigns for this specific Conversation (lead).
owner.phone	700-070-0707	string	This field will override the default phone number that is used in live transferring a Customer for this specific Conversation (lead).
owner.callCenterRoutingNumber	1234567890	string	This field will override the default CallConnect number that a lead is connected to for Callconnect accounts for this Conversation (lead) only.
owner.personaTeamName	Clear Water Flood Cleanup	string	This field will override the default Team Name used when engaging in a Customer during this specific conversation.
teamLevel	true	true/false	This can be optionally passed to end conversations for team members when using the Team Admin API key NOTE: If teamLevel is True, the only \"searchValue\" supported is the \"leadId\".
leadConversionAmount	1234.00	number	This field can be used to capture the revenue from a Conversation (lead) as a whole number.
leadConverted	true	true/false	This field indicates whether or not the Conversation (lead) was converted successfully to a Customer from a Conversation (lead).

The \"Update Lead\" endpoint allows you to modify Conversation (lead) details, including fields like phone number, Verse ID, zapierLeadId, conversion metrics, and custom fields.

Key Features

Conversation Identification via `searchValue`

You can identify the Conversation (lead) to update by providing one of the following:

phoneNumber: If multiple Conversations (leads) exist for the same phone number, the system will return a 409 response. Use the Search API to retrieve the corresponding leadId and pass it to the update instead.
\n
leadId: Allows you to specifically select the Conversation (lead) you wish to update, and is the most accurate method to update a Conversation (lead).
\n
zapierLeadId: The value you submitted when the Conversation (lead) was created.
\n

The system automatically searches for the corresponding field based on your input.

Conversion Metrics

Track whether a Conversation (lead) worked by Verse was successfully converted by your team. This is done by updating the following fields:

leadConverted: A boolean indicating whether the Conversation (lead) was converted.
\n
leadConversionAmount: A numeric field representing the conversion value. Values can be whole numbers or decimals.
\n

Note: Once you start using Conversion Metrics, notify your Account Executive to enable the Conversion Metrics Insights Dashboard in your system.

Custom Fields

Custom fields can be added or updated but not removed. To update existing custom fields, include the field in the JSON array of your update request. Fields not included in the update will persist unchanged.

Example Use Cases

Update a Customer's (lead's) phone number or custom attributes.
\n
Track conversion status and revenue for successfully converted Conversation (lead).
\n
Add or modify custom fields to reflect new Conversation (lead) data.
\n

Process

Identify the Conversation (lead) using phone number, Verse ID, or zapierLeadId.
\n
Submit an update request with the desired modifications.
\n
Persisted fields not included in the request remain unchanged.
\n

For more information or assistance, refer to the API documentation or contact your Account Executive.

\n","urlObject":{"protocol":"https","path":["v1","zapier","lead"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"bbfb0184-aac2-42fb-9f3b-6d8d4e6e4b81","name":"200 OK RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstName\": \"Buzz\",\r\n \"lastName\": \"Aldrin\",\r\n \"email\": \"buzzaldrin@verse.io\",\r\n \"searchValue\": \"619-123-4567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/lead"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n status: \"success\"\r\n}"},{"id":"6ef344a2-fc33-4aaf-85ae-a40b3db218ca","name":"Conversion Metrics Example","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\": \"cfdc10f0-f7ae-49f6-8343-b651f4620cbc\",\r\n \"leadConversionAmount\" : 500,\r\n \"leadConverted\": true\r\n}"},"url":"https://api.verse.io/v1/zapier/lead"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 26 Jul 2023 14:21:30 GMT"},{"key":"x-amzn-RequestId","value":"1886beed-c16f-408e-a81f-7f53245ae1e2"},{"key":"x-amz-apigw-id","value":"IrPMpFpsvHcFRWw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64c12bea-6c0d977274c8721a479cf371;Sampled=0;lineage=8f71726a:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 a0fb1c3995ef4da6581cce47df6405c4.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LAX50-P1"},{"key":"X-Amz-Cf-Id","value":"2TFwERCodegXmDfB63N8ArJ8zrOzyZiUNDXa-auAs8jniXU9jbIOcQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"},{"id":"96d37c33-7232-480b-b6ac-8481d11214fe","name":"Conversion Metrics Example 2","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\": \"cfdc10f0-f7ae-49f6-8343-b651f4620cbc\",\r\n \"leadConversionAmount\" : 5.50,\r\n \"leadConverted\": true\r\n}"},"url":"https://api.verse.io/v1/zapier/lead"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 26 Jul 2023 14:40:43 GMT"},{"key":"x-amzn-RequestId","value":"a9dba8e8-0217-44a4-aede-475301803a7f"},{"key":"x-amz-apigw-id","value":"IrSAXFRcvHcFYCw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-64c13068-12caeded260ec13a58ac2897;Sampled=0;lineage=8f71726a:0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 097b5de2aef2f90d989b3bd165cf771a.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LAX50-P1"},{"key":"X-Amz-Cf-Id","value":"ldZ8hyULQT97Qd_a2TNJCpAyC4uAQ6-_HcAQJrEDFo7sXrG7KbDxtQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"713d4ac0-e485-4a39-8b03-886acfeb8e24"},{"name":"End Conversation (Qualify)","id":"21d3a5fe-e31d-4076-b02a-560f83b97d25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"(619) 555-5555\"\r\n}"},"url":"https://api.verse.io/v1/zapier/end-conversation","description":"

End Conversation

The \"End Conversation\" endpoint allows you to mark a conversation as completed, designating the Conversation (lead) as \"Qualified.\" Once a conversation is ended using this method, the Conversation (lead) will no longer be actively engaged by Verse.

Key Features:

Qualification: Automatically marks the Conversation (lead) as \"Qualified\" with the appropriate status.
\n
Discontinued Engagement: Ensures that no further proactive outreach will be initiated for the Conversation (lead) by Verse.
\n
Notification on Conversation (lead) Response: If the Customer responds after the conversation is ended, an email notification will be sent to the Account Manager with the Customer's comments and context.
\n

Example Use Cases:

A Conversation (lead) completes the necessary steps to qualify outsid of Verse's engagement, and the conversation is marked as concluded.
\n
A conversation (lead) is ended due to the Customer indicating readiness to proceed without further engagement from Verse.
\n

Process:

Call the \"End Conversation\" endpoint to mark the Conversation (lead) as qualified.
\n
Verse ceases all proactive engagement with the Conversation (lead), acknowledging their qualification status.
\n
If the Customer initiates further contact, the Account Manager is promptly notified via email for additional follow-up.
\n

For more information or specific implementation details, refer to the API documentation or consult your Account Executive.

Field Details

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

Field Name	Field Example	Type	Description
searchValue	john@gmail.com	string	Email, Phone, leadId
teamLevel	true	true/false	This can be optionally passed to end conversations for team members when using the Team Admin API key NOTE: If teamLevel is True, the only \"searchValue\" supported is the \"leadId\".

\n
NOTE: the searchValue will match the first Conversation (lead) that it finds. If you choose to search by externalLeadId and more than one Conversation (lead) is found for the value passed, the API will return a 409
\n

\n","urlObject":{"protocol":"https","path":["v1","zapier","end-conversation"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"8e67b641-a026-4e25-98b1-5f3f5736229d","name":"200 OK PHONE RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"619-123-4567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/end-conversation"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"},{"id":"32b952fa-f738-442c-b216-f67d6c54633e","name":"200 OK EMAIL RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"buzzaldrin@verse.io\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/end-conversation"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"}],"_postman_id":"21d3a5fe-e31d-4076-b02a-560f83b97d25"},{"name":"Stop Conversation (Unqualify)","id":"1cdcbb75-b083-4f7a-a5e5-95224febaa31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"(619) 555-5555\"\r\n}"},"url":"https://api.verse.io/v1/zapier/stop-conversation","description":"

Stop Conversation

The \"Stop Contact\" endpoint allows you to mark a conversation as stopped, effectively designating the Conversation (lead) as \"Unqualified.\" Customers whose conversations are stopped using this method will no longer be engaged by Verse, as their number will be added to the Blacklist. If you would like to pre-emptively add a Customer's Number to the blacklist, please use the DNC (Opt-Out) Endpoint.

Key Features:

Unqualification: Automatically marks the Conversation (lead) as \"Unqualified\" with the appropriate status.
\n
Discontinued Engagement: Ensures that no further outreach will be initiated for the Conversation (lead) by Verse.
\n
Notification on Conversation (lead) Response: If the Customer responds after the conversation is stopped, an email notification will be sent to the Account Manager with the Customer's comments and context.
\n

Example Use Cases:

A Customer explicitly requests to you outside of Verse's engagement to stop communication and is the conversation is marked as unqualified.
\n
A conversation is ended due to inactivity or non-responsiveness, and the Customer (lead) should no longer receive outreach.
\n

Process:

Call the \"Stop Contact\" endpoint to mark the Conversation (lead) as unqualified.
\n
Verse halts all engagement with the Customer in the Conversation (lead), ensuring compliance with communication preferences.
\n
If the Customer initiates contact again in the conversation, the Account Manager is promptly notified via email for further action.
\n

For more information or specific implementation details, refer to the API documentation or consult your Account Executive.

Field Details

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

Field Name	Field Example	Type	Description
searchValue	john@gmail.com	string	Email, Phone, leadId
teamLevel	true	true/false	This can be optionally passed to end conversations for team members when using the Team Admin API key NOTE: If teamLevel is True, the only \"searchValue\" supported is the \"leadId\".

\n
NOTE: the searchValue will match the first Conversation (lead) that it finds. If you choose to search by externalLeadId and more than one Conversation (lead) is found for the value passed, the API will return a 409
\n

\n","urlObject":{"protocol":"https","path":["v1","zapier","stop-conversation"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"c1c1e74b-3dd5-4d9b-aaae-73ffad16fb54","name":"200 OK RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"(619) 555-5555\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/stop-conversation"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"},{"id":"44ae4505-653c-4426-846b-051f66680f10","name":"200 OK EMAIL RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"buzzaldrin@verse.io\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/stop-conversation"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"}],"_postman_id":"1cdcbb75-b083-4f7a-a5e5-95224febaa31"},{"name":"DNC (Opt-Out)","id":"1eb7d21e-b49f-4d4a-bba0-ad1bc1f4caa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"X-API-KEY","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"(619) 555-5555\"\r\n}"},"url":"https://api.verse.io/v1/zapier/stop-contact","description":"

DNC (Opt-Out)

Ending a conversation (lead) marks the Customer as \"Unqualified\" with the reason \"Stop Contact.\" This action also:

Adds the Customer's phone number to your SMS blacklist, preventing future SMS communication with this lead.
\n
Ensures that if you resubmit a Customer with this phone number and no email address, the Conversation (lead) will automatically be marked as unqualified.
\n
If an email address is provided, an email-only campaign will be initiated.
\n

\n
Note: The Number does not need to be used for a Conversation in Verse in order to be added to the SMS blacklist. You can be pro-active in your blacklist management.
\n

Field Details

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

Field Name	Field Example	Type	Description
searchValue	john@gmail.com	string	Email, Phone, leadId
teamLevel	true	true/false	This can be optionally passed to end conversations for team members when using the Team Admin API key NOTE: If teamLevel is True, the only \"searchValue\" supported is the \"leadId\".

\n
NOTE: the searchValue will match the first Conversation (lead) that it finds. If you choose to search by externalLeadId and more than one lead is found for the value passed, the API will return a 409
\n

\n","urlObject":{"protocol":"https","path":["v1","zapier","stop-contact"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"d0457f54-e5bb-4c3b-960f-d5e2663da897","name":"200 OK PHONE RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"619-123-4567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/stop-contact"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"},{"id":"2af5616c-38dd-4da8-bdc2-e6c44b4c4b21","name":"200 OK EMAIL RESPONSE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"X-API-KEY","value":""}],"body":{"mode":"raw","raw":"{\r\n \"searchValue\" : \"buzzaldrin@verse.io\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.verse.io/v1/zapier/stop-contact"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n firstName: 'Buzz',\r\n lastName: 'Aldrin',\r\n email: 'buzzaldrin@verse.io',\r\n phone: '619-123-4567',\r\n phoneCarrierType: 'mobile',\r\n leadType: 'buyer',\r\n street: '101 West Broadway',\r\n city: 'San Diego',\r\n state: 'CA',\r\n postalCode: '92101',\r\n leadComment: '!! Summary Text !!',\r\n additionalNote : '!! Additional Note !!',\r\n leadSource: 'Zillow'\r\n}"}],"_postman_id":"1eb7d21e-b49f-4d4a-bba0-ad1bc1f4caa8"},{"name":"Search","id":"ba3e7b22-fd9e-4788-9a88-acac36038ec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the X-API-KEY header generated by Postman.","key":"X-API-KEY","value":"","type":"text"},{"key":"accept","value":"application/json","type":"text"}],"url":"https://api.verse.io/v1/zapier/search?searchKey=leadId&searchValue=&limit=1-100","description":"

Search Lead

The \"Search\" endpoint allows you to perform advanced searches via the API, enabling retrieval of data based on specific criteria. This endpoint is designed to provide flexibility in querying and filtering information within the Verse platform.

Field Details

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

Field Name	Field Example	Type	Description
searchKey	email	string	firstName, lastName, email, phone, leadId, externalLeadId
searchValue	john@gmail.com	string	This field depends on the searchKey specified in order to return the desired result.
teamLevel	true	true/false	This can be optionally passed to end conversations for team members when using the Team Admin API key NOTE: If teamLevel is True, the only \"searchValue\" supported is the \"leadId\".
limit	1-100	integer	allows you to set a limit on the results

\n
NOTE: the response body will be returned in an array that provides all leads that match your searchValue. When using email, firstName, lastName, phone or externalLeadId more than one result may be returned.
\n

\n","urlObject":{"protocol":"https","path":["v1","zapier","search"],"host":["api","verse","io"],"query":[{"description":{"content":"

Acceptable inputs are: firstName, lastName, email, phone, leadId, externalLeadId

\n","type":"text/plain"},"key":"searchKey","value":"leadId"},{"description":{"content":"

the value required for this field is determined by the searchKey specified

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

if you would like to limit your results

\n","type":"text/plain"},"key":"limit","value":"1-100"}],"variable":[]}},"response":[{"id":"4fff400c-8218-4eaf-b1f5-90b3543d2841","name":"Search - firstName","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"accept","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://api.verse.io/v1/zapier/search?searchKey=firstName&searchValue=Matt","protocol":"https","host":["api","verse","io"],"path":["v1","zapier","search"],"query":[{"key":"searchKey","value":"firstName","description":"Acceptable inputs are: firstName, lastName, email, phone, leadId, externalLeadId"},{"key":"searchValue","value":"Matt","description":"the value required for this field is determined by the searchKey specified"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"616"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"channelWebsite\": \"Test\",\n \"city\": null,\n \"email\": \"matthew@verse.io\",\n \"firstName\": \"Matt\",\n \"lastName\": \"White\",\n \"leadComment\": \"Lead is not interested at this time. Will reach out if anything changes.\",\n \"leadType\": \"solar\",\n \"phone\": \"+16125555555\",\n \"phoneCarrierType\": \"mobile\",\n \"postalCode\": null,\n \"state\": null,\n \"street\": null,\n \"link\": \"https://app.verse.io/leads/54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"externalLeadId\": null,\n \"title\": \"Qualified Lead\",\n \"message\": \"We've qualified a new lead for you!\",\n \"customFields\": null,\n \"additionalNote\": null,\n \"lastCommunicationChannel\": \"sms\",\n \"createdAt\": \"2023-08-08T16:46:18.000Z\",\n \"customQuestions\": {}\n }\n]"},{"id":"930bdd7c-2304-47b8-a526-63e269125b10","name":"Search - lastName","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"accept","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://api.verse.io/v1/zapier/search?searchKey=lastName&searchValue=White","protocol":"https","host":["api","verse","io"],"path":["v1","zapier","search"],"query":[{"key":"searchKey","value":"lastName","description":"Acceptable inputs are: firstName, lastName, email, phone, leadId, externalLeadId"},{"key":"searchValue","value":"White","description":"the value required for this field is determined by the searchKey specified"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"616"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"channelWebsite\": \"Test\",\n \"city\": null,\n \"email\": \"matthew@verse.io\",\n \"firstName\": \"Matt\",\n \"lastName\": \"White\",\n \"leadComment\": \"Lead is not interested at this time. Will reach out if anything changes.\",\n \"leadType\": \"solar\",\n \"phone\": \"+16125555555\",\n \"phoneCarrierType\": \"mobile\",\n \"postalCode\": null,\n \"state\": null,\n \"street\": null,\n \"link\": \"https://app.verse.io/leads/54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"externalLeadId\": null,\n \"title\": \"Qualified Lead\",\n \"message\": \"We've qualified a new lead for you!\",\n \"customFields\": null,\n \"additionalNote\": null,\n \"lastCommunicationChannel\": \"sms\",\n \"createdAt\": \"2023-08-08T16:46:18.000Z\",\n \"customQuestions\": {}\n }\n]"},{"id":"40f23489-4a37-4b0d-b126-0da9fdf26c16","name":"Search - leadId","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"accept","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://api.verse.io/v1/zapier/search?searchKey=leadId&searchValue=54066d5d-d114-4f4a-a0eb-a5a21636af2c&teamLevel=true","protocol":"https","host":["api","verse","io"],"path":["v1","zapier","search"],"query":[{"key":"searchKey","value":"leadId","description":"Acceptable inputs are: firstName, lastName, email, phone, leadId, externalLeadId"},{"key":"searchValue","value":"54066d5d-d114-4f4a-a0eb-a5a21636af2c","description":"the value required for this field is determined by the searchKey specified"},{"key":"teamLevel","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"616"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"channelWebsite\": \"Test\",\n \"city\": null,\n \"email\": \"matthew@verse.io\",\n \"firstName\": \"Matt\",\n \"lastName\": \"White\",\n \"leadComment\": \"Lead is not interested at this time. Will reach out if anything changes.\",\n \"leadType\": \"solar\",\n \"phone\": \"+16125555555\",\n \"phoneCarrierType\": \"mobile\",\n \"postalCode\": null,\n \"state\": null,\n \"street\": null,\n \"link\": \"https://app.verse.io/leads/54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"externalLeadId\": null,\n \"title\": \"Qualified Lead\",\n \"message\": \"We've qualified a new lead for you!\",\n \"customFields\": null,\n \"additionalNote\": null,\n \"lastCommunicationChannel\": \"sms\",\n \"createdAt\": \"2023-08-08T16:46:18.000Z\",\n \"customQuestions\": {}\n }\n]"},{"id":"3227cf90-d29a-4152-a3f1-fcaef507fa67","name":"Search - leadId (limit)","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text","disabled":true},{"key":"accept","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://api.verse.io/v1/zapier/search?searchKey=leadId&searchValue=54066d5d-d114-4f4a-a0eb-a5a21636af2c&teamLevel=true&limit=1","protocol":"https","host":["api","verse","io"],"path":["v1","zapier","search"],"query":[{"key":"searchKey","value":"leadId","description":"Acceptable inputs are: firstName, lastName, email, phone, leadId, externalLeadId"},{"key":"searchValue","value":"54066d5d-d114-4f4a-a0eb-a5a21636af2c","description":"the value required for this field is determined by the searchKey specified"},{"key":"teamLevel","value":"true"},{"key":"limit","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"616"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\n{\n \"id\": \"54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"channelWebsite\": \"Test\",\n \"city\": null,\n \"email\": \"matthew@verse.io\",\n \"firstName\": \"Matt\",\n \"lastName\": \"White\",\n \"leadComment\": \"Lead is not interested at this time. Will reach out if anything changes.\",\n \"leadType\": \"solar\",\n \"phone\": \"+16125555555\",\n \"phoneCarrierType\": \"mobile\",\n \"postalCode\": null,\n \"state\": null,\n \"street\": null,\n \"link\": \"https://app.verse.io/leads/54066d5d-d114-4f4a-a0eb-a5a21636af2c\",\n \"externalLeadId\": null,\n \"title\": \"Qualified Lead\",\n \"message\": \"We've qualified a new lead for you!\",\n \"customFields\": null,\n \"additionalNote\": null,\n \"lastCommunicationChannel\": \"sms\",\n \"createdAt\": \"2023-08-08T16:46:18.000Z\",\n \"customQuestions\": {}\n}\n"}],"_postman_id":"ba3e7b22-fd9e-4788-9a88-acac36038ec3"},{"name":"Scripts","id":"3550418e-ba6b-48c2-babe-272d954a2f96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"accept","value":"application/json","type":"text"}],"url":"https://api.verse.io/v1/zapier/scripts","description":"

Get a List of Scripts

The \"Get a List of Scripts\" endpoint allows you to search and retrieve all script IDs that may be assigned to a Conversation (lead) during the Create Lead action. The endpoint provides detailed information about each script, including its ownership level and key attributes.

Ownership Levels

Global:
\n
- Templated scripts available for use by anyone.
  \n
- These scripts cannot be customized.
  \n
- Customers may request to clone and modify these scripts to convert them into Team or Agent types.
  \n
\n
Team:
\n
- Owned by a customer's team and accessible to all team members.
  \n
- Typically maintained by the Team Admin or your Account Executive.
  \n
- Changes to these scripts will affect all team members using them.
  \n
\n
Agent:
\n
- Owned by a specific team member and usable only by that member.
  \n
- Highly customizable without impacting other team members.
  \n
\n

Returned Fields

In addition to the scriptId, the following fields are noteworthy:

name

Identifies the script.
\n
Script names can be updated upon request to reflect appropriate use cases. Contact your Account Executive for updates.
\n

allowStartingOffHours

True: Indicates that the first outbound action (message or call) in the Conversation (lead) will occur regardless of the time of day. This setting is generally used for Customers actively requesting contact and should not be applied to Customers who haven’t recently requested to be contacted.
\n
False: Indicates that Conversations (Leads) created outside automatable hours of operation will have their first action delayed until the next available automatable hours.
\n
- Example: For a Conversation (lead) in Connecticut created at 8:01 PM, if this setting is false, the initial message will be delayed until 9:00 AM the next day.
\n

For additional details on automatable hours, including state-specific holidays, refer to State-Specific Holidays & Hours.

\n","urlObject":{"protocol":"https","path":["v1","zapier","scripts"],"host":["api","verse","io"],"query":[],"variable":[]}},"response":[{"id":"e4241208-f93d-48ed-94e1-5f5d43ce0831","name":"Scripts - Example Response","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"","type":"text"},{"key":"accept","value":"application/json","type":"text"}],"url":"https://api.verse.io/v1/zapier/scripts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5546"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Jan 2025 20:33:33 GMT"},{"key":"X-Amzn-Trace-Id","value":"Root=1-6780329c-3de4a7e03ad07cf001c00d8c;Parent=5c2ba020e02db6f5;Sampled=0;Lineage=1:bb831fc2:0"},{"key":"x-amzn-RequestId","value":"f94b10d3-31b8-4954-98d1-cae4e2a4094e"},{"key":"x-amz-apigw-id","value":"EIzYiFFcPHcEcAA="},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 cf1928ef9a9a7bb589a35ead31bcb4ea.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"DEN52-C1"},{"key":"X-Amz-Cf-Id","value":"DMAqll2ro1V7tdYS9ulfNNkIzCUWY04U2kuaYWh7nAAFJCOTnVoAqg=="}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"034fa3df-45d3-4acb-9516-7408abf1b45d\",\n \"name\": \"James Test Script\",\n \"ownershipLevel\": \"Agent\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"272fb6c7-379a-4398-b032-1302f9cd8d31\",\n \"name\": \"Deprecated Test Script\",\n \"ownershipLevel\": \"Team\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"d5909ecb-16ca-443b-b215-7ba25060c0be\",\n \"name\": \"Review Generation (Demo)\",\n \"ownershipLevel\": \"Team\",\n \"allowStartingOffHours\": false\n },\n {\n \"id\": \"c7c9dcdd-387d-4c7c-be61-5a27d6f9702f\",\n \"name\": \"Test CallConnect\",\n \"ownershipLevel\": \"Team\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"14d42f66-77c0-4918-b202-87560f6fad7a\",\n \"name\": \"Testing Mapping Script\",\n \"ownershipLevel\": \"Team\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"5a7efa3a-db7f-495b-8b9e-d117758779d9\",\n \"name\": \"Blank Template (For Solar Accounts)\",\n \"ownershipLevel\": \"Global\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"2f1c9136-1a47-4070-b926-1f4936cbdeb4\",\n \"name\": \"Default CallConnect Template (Live Leads)\",\n \"ownershipLevel\": \"Global\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"fb63d33d-c173-47ed-885f-dbcb933f8bca\",\n \"name\": \"Default CallConnect w Priority Questions Template\",\n \"ownershipLevel\": \"Global\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"3e5295b2-9838-4aab-86e8-de7ea858c030\",\n \"name\": \"Default Home Services Template (as of 2022) - Standard\",\n \"ownershipLevel\": \"Global\",\n \"allowStartingOffHours\": true\n },\n {\n \"id\": \"5c4284b2-b387-4854-9485-e510655ffda2\",\n \"name\": \"Default Mortgage + Refi ASFU\",\n \"ownershipLevel\": \"Global\",\n \"allowStartingOffHours\": true\n }\n]"}],"_postman_id":"3550418e-ba6b-48c2-babe-272d954a2f96"}]}

Overview

Getting Started

For Conversation (Lead) Creation Only

For Conversation (Lead) Updates via Webhooks

Managing Conversations

Use Case: Ending Conversations

Account and Subscription Management

Single vs. Multiple Accounts

Conclusion

Notable Changes

Error Codes

Key Features

Team-Level vs Individual-Level Subscriptions

Event Field

Customizable Headers

URL Field

Required Headers for Webhook Subscription

Example Use Cases

Process

How to subscribe?

How to Subscribe

Available Event Types

Verse Activity Types \"title\"

Field Descriptions

Field Details

Field Details

Key Features

Conversation Identification via searchValue

Conversion Metrics

Custom Fields

Example Use Cases

Process

End Conversation

Key Features:

Example Use Cases:

Process:

Field Details

Stop Conversation

Key Features:

Example Use Cases:

Process:

Field Details

DNC (Opt-Out)

Field Details

Search Lead

Field Details

Get a List of Scripts

Ownership Levels

Returned Fields

name

allowStartingOffHours

Conversation Identification via `searchValue`