{
"openapi": "3.0.0",
"info": {
"title": "Bonzo: Public API",
"termsOfService": "https://platform.getbonzo.com/pdf/saas-agreement.pdf",
"contact": {
"email": "developers@getbonzo.com"
},
"version": "3.0.0"
},
"servers": [
{
"url": "http://bonzo.site/api/v3"
}
],
"paths": {
"/broadcast-voicemails": {
"get": {
"tags": [
"Messaging"
],
"summary": "Voicemails",
"description": "List voicemails created by user",
"operationId": "broadcastVoicemailIndex",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoicemailResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"post": {
"tags": [
"Messaging"
],
"summary": "Create voicemail broadcast",
"description": "Creates a voicemail brodcast",
"operationId": "broadcastVoicemailStore",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"audio_data"
],
"properties": {
"audio_data": {
"type": "string",
"format": "binary"
},
"is_visible": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/VoicemailResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/broadcast-voicemails/{voicemail}": {
"put": {
"tags": [
"Messaging"
],
"summary": "Update voicemail broadcast",
"description": "Updates a voicemail brodcast",
"operationId": "broadcastVoicemailUpdate",
"parameters": [
{
"name": "voicemail",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"friendly_name": {
"type": "string",
"example": "My voicemail"
},
"is_visible": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/VoicemailResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"delete": {
"tags": [
"Messaging"
],
"summary": "Delete voicemail broadcast",
"description": "Deletes a voicemail brodcast",
"operationId": "broadcastVoicemailDelete",
"parameters": [
{
"name": "voicemail",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Voicemail has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/campaigns": {
"get": {
"tags": [
"Campaigns"
],
"summary": "List campaigns",
"description": "Returns a list of all campaigns the user has access to",
"operationId": "campaignIndex",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search by name",
"schema": {
"type": "string",
"example": "Campaign name"
}
},
{
"name": "active_only",
"in": "query",
"schema": {
"type": "boolean",
"enum": [
"true"
],
"example": "true"
}
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"consequtive",
"date_based"
],
"example": "date_based"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"name",
"messages",
"prospects",
"status"
],
"example": "name"
}
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": [
"desc",
"asc"
],
"example": "desc"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "no_paginate",
"in": "query",
"schema": {
"type": "boolean",
"example": []
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/upload": {
"post": {
"tags": [
"Chat"
],
"summary": "Upload attachment",
"description": "Upload a new file/photo/video to the chat room",
"operationId": "chatAttachmentsStore",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"attachment",
"name"
],
"properties": {
"attachment": {
"type": "string",
"format": "binary"
},
"name": {
"type": "integer",
"example": "file-name"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/store-gif": {
"post": {
"tags": [
"Chat"
],
"summary": "Upload gif",
"description": "Upload a new gif to the chat room",
"operationId": "chatAttachmentsStoreGit",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"url"
],
"properties": {
"url": {
"type": "integer",
"example": "https://media1.giphy.com/media/jpbnoe3UIa8TU8LM13/giphy.gif?cid=ecf05e47zqpz5adqdb72jm30j1j66cbrzr7mt6tfgsaa62ke&rid=giphy.gif&ct=g"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/photos": {
"get": {
"tags": [
"Chat"
],
"summary": "List of photos",
"description": "Returns a list of uploaded photos",
"operationId": "chatAttachmentsPhotos",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/documents": {
"get": {
"tags": [
"Chat"
],
"summary": "List of documemts",
"description": "Returns a list of uploaded documents",
"operationId": "chatAttachmentsDocuments",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/users": {
"get": {
"tags": [
"Chat"
],
"summary": "List private chats",
"description": "Returns a list of private chat threads",
"operationId": "chatMembersIndex",
"parameters": [
{
"name": "show_all_teams",
"in": "query",
"schema": {
"type": "boolean",
"example": "true"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/add-members": {
"post": {
"tags": [
"Chat"
],
"summary": "Adds a member to a *public* chat room. Can only be used by chat owner",
"description": "Desription",
"operationId": "chatMembersStore",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"selectedUsers"
],
"properties": {
"selectedUsers[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/remove-member/{user}": {
"post": {
"tags": [
"Chat"
],
"summary": "Remove member from chat room",
"description": "Removes a member from a *public* chat room. Can only be used by chat owner ",
"operationId": "chatMembersDelete",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "user",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}": {
"get": {
"tags": [
"Chat"
],
"summary": "List messages from thread",
"description": "Lists messages from chat thread with information about sender",
"operationId": "chatMessageIndex",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"put": {
"tags": [
"Chat"
],
"summary": "Update a group chat",
"description": "Update a group chat infromation",
"operationId": "chatRoomUpdate",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"name": {
"type": "string",
"example": "Chat room name"
},
"topic": {
"type": "string",
"example": "Chat room topic"
},
"description": {
"type": "string",
"example": "Chat room description"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"post": {
"tags": [
"Chat"
],
"summary": "Post a new message",
"description": "Creates a new message in the chat thread and notifies all of the participants.",
"operationId": "chatMessageStore",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"example": "Message content"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/search": {
"post": {
"tags": [
"Chat"
],
"summary": "Search chat thread",
"description": "Searches for a message in the chat thread.",
"operationId": "taskSearch",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"search"
],
"properties": {
"search": {
"type": "string",
"example": "Message content"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/read/{chatMessage}": {
"post": {
"tags": [
"Chat"
],
"summary": "Mark message as read",
"description": "Indicates that the message was read by authenticated user.",
"operationId": "chatMessagesRead",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "chatMessage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessageResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat-message/{chatMessage}/delete": {
"delete": {
"tags": [
"Chat"
],
"summary": "Delete a message",
"description": "Removes a message from the chat thread.",
"operationId": "chatMessagesDelete",
"parameters": [
{
"name": "chatMessage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Message has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/all-rooms": {
"get": {
"tags": [
"Chat"
],
"summary": "List all chat rooms",
"description": "Returns a list of all chat rooms that authenticated user has access to",
"operationId": "chatRoomRooms",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/new": {
"post": {
"tags": [
"Chat"
],
"summary": "Create a group chat",
"description": "Creates a group chat with selected users",
"operationId": "chatRoomStore",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"selectedUsers"
],
"properties": {
"selectedUsers[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/leave": {
"delete": {
"tags": [
"Chat"
],
"summary": "Leave a chat room",
"description": "Leaves a chat room, if authenticated user is *not* the owner of the room.",
"operationId": "chatRoomLeave",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/{chatRoom}/delete": {
"delete": {
"tags": [
"Chat"
],
"summary": "Delete a chat room",
"description": "Deletes a chat room, if authenticated user is the owner of the room",
"operationId": "chatRoomDelete",
"parameters": [
{
"name": "chatRoom",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Chat room has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/chat/users/{user}": {
"post": {
"tags": [
"Chat"
],
"summary": "Create a private channel",
"description": "Creates a private channel between authenticated user and selected user.",
"operationId": "chatRoomPrivateChannel",
"parameters": [
{
"name": "user",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatRoomResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/conversations": {
"get": {
"tags": [
"Messaging"
],
"summary": "Get conversation prospect",
"description": "Returns a list of prospects that have active conversation",
"operationId": "conversationIndex",
"parameters": [
{
"name": "assigned_to",
"in": "query",
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "do_not_call",
"in": "query",
"schema": {
"type": "boolean",
"example": "false"
}
},
{
"name": "include_conversationlist",
"in": "query",
"schema": {
"type": "boolean",
"example": "false"
}
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string",
"example": "John"
}
},
{
"name": "show_all",
"in": "query",
"schema": {
"type": "boolean",
"example": "true"
}
},
{
"name": "show_all_teams",
"in": "query",
"schema": {
"type": "boolean",
"example": "true"
}
},
{
"name": "view",
"in": "query",
"schema": {
"type": "string",
"enum": [
"all",
"unread",
"snoozed"
],
"example": "unread"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProspectConversationSidebarResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/conversations/{prospect}/read": {
"post": {
"tags": [
"Messaging"
],
"summary": "Mark conversation as read",
"description": "Marks conversation with prospect as read",
"operationId": "conversationStore",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "ok"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/conversations/count": {
"get": {
"tags": [
"Messaging"
],
"summary": "Get conversation count",
"description": "Returns count of active conversations",
"operationId": "conversationCount",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"conversations": {
"type": "integer",
"example": "3"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/attachments/email": {
"post": {
"tags": [
"Messaging"
],
"summary": "Create Email attachment",
"description": "Returns a link that can be passed to `Send Email` endpoint",
"operationId": "emailAttachment",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"attachment"
],
"properties": {
"attachment": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"path": {
"type": "string",
"example": "example_file"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/settings/fields/groups": {
"get": {
"tags": [
"Prospects"
],
"summary": "List custom fields",
"description": "Returns a list of prospect custom fields",
"operationId": "fieldGroupsIndex",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldGroupResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/merge-tags": {
"get": {
"tags": [
"User"
],
"summary": "List merge tags",
"description": "Returns all merge tags that'll be populated for current user",
"operationId": "mergeTags",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"industry": {
"type": "array",
"items": {
"type": "string",
"example": "loan_amount"
}
},
"custom": {
"type": "object",
"example": {
"field_1": "Custom #1"
}
},
"general": {
"type": "object",
"example": {
"prospect_first_name": "Person first name"
}
},
"fields": {
"type": "object",
"example": {
"1": "Favorite color"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/notes": {
"get": {
"tags": [
"Prospects"
],
"summary": "List notes",
"description": "Returns a list of prospect notes",
"operationId": "noteIndex",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"post": {
"tags": [
"Prospects"
],
"summary": "Create note",
"description": "Creates a prospect note",
"operationId": "noteStore",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"example": "Example note content"
},
"is_pinned": {
"type": "boolean",
"example": "true"
},
"include_in_conversation": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/NoteResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/notes/{note}": {
"put": {
"tags": [
"Prospects"
],
"summary": "Update note",
"description": "Updates a prospect note",
"operationId": "noteUpdate",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "note",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "2"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"example": "Example note content"
},
"is_pinned": {
"type": "boolean",
"example": "true"
},
"include_in_conversation": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/NoteResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"delete": {
"tags": [
"Prospects"
],
"summary": "Delete note",
"description": "Deletes a prospect note",
"operationId": "noteDelete",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "note",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Note has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/notifications": {
"get": {
"tags": [
"User"
],
"summary": "List notifications",
"description": "Returns all of the notifications",
"operationId": "notificationsIndex",
"parameters": [
{
"name": "all",
"in": "query",
"schema": {
"type": "boolean",
"example": "true"
}
},
{
"name": "unread",
"in": "query",
"schema": {
"type": "boolean",
"example": "false"
}
},
{
"name": "category",
"in": "query",
"schema": {
"type": "integer",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21"
],
"example": "1"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/notifications/count": {
"get": {
"tags": [
"User"
],
"summary": "Count notifications",
"description": "Returns the number of unread notifications",
"operationId": "notificationsCount",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "integer",
"example": "5"
}
},
"type": "object"
}
}
}
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/notifications/delete/{notification}": {
"delete": {
"tags": [
"User"
],
"summary": "Delete notifications",
"description": "Remove a notification from the list of notifications",
"operationId": "notificationDelete",
"parameters": [
{
"name": "notification",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "ok"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/notifications/read/{notification}": {
"post": {
"tags": [
"User"
],
"summary": "Read notifications",
"description": "Mark notification as read",
"operationId": "notificationReadStore",
"parameters": [
{
"name": "notification",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "ok"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/notifications/read-all": {
"post": {
"tags": [
"User"
],
"summary": "Read all notifications",
"description": "Mark all notification as read",
"operationId": "notificationReadStoreAll",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "ok"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/pipelines": {
"get": {
"tags": [
"Pipelines"
],
"summary": "List pipeliens",
"description": "Returns a list of pipelines that this user has access to",
"operationId": "pipelineIndex",
"parameters": [
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "no_paginate",
"in": "query",
"schema": {
"type": "boolean",
"example": []
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PipelineResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/pipelines/fetch/{pipeline}": {
"get": {
"tags": [
"Pipelines"
],
"summary": "Show pipeline",
"description": "Returns detailed data on a pipeline",
"operationId": "pipelineFetch",
"parameters": [
{
"name": "pipeline",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/PipelineResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/pipeline-stage/{pipelineStage}": {
"post": {
"tags": [
"Pipelines"
],
"summary": "Move prospect to pipeline",
"description": "Changes prospect stage to selected pipeline stage",
"operationId": "pipelinePorspectMove",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "pipelineStage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Person has been successfully assigned."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"500": {
"description": "Error: An error occurred. Couldn't assign that person"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/pipeline-stages/{pipelineStage}/assign": {
"post": {
"tags": [
"Pipelines"
],
"summary": "Moves prospects in bulk to pipeline",
"description": "Changes prospect stage to selected pipeline stage in bulk",
"operationId": "pipelinePorspectAssign",
"parameters": [
{
"name": "pipelineStage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"prospects[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
},
"is_all": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "People have been successfully assigned."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"500": {
"description": "Error: An error occurred. Couldn't assign selected people"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/pipeline-stages/{pipelineStage}/unassign/{prospect}": {
"post": {
"tags": [
"Pipelines"
],
"summary": "Unassign prospect",
"description": "Removes prospect from pipeline stage",
"operationId": "pipelinePorspectUnassign",
"parameters": [
{
"name": "pipelineStage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Person has been unassigned."
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/pipeline-stages/{pipelineStage}/prospects": {
"get": {
"tags": [
"Pipelines"
],
"summary": "List prospects on stage",
"description": "Returns a list of prospects on a certain stage",
"operationId": "pipelineStageProspects",
"parameters": [
{
"name": "pipelineStage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/communication": {
"get": {
"tags": [
"Messaging"
],
"summary": "Get communication history",
"description": "Returns the entire communication history with prospect. All incoming and outgoing messages as well as activity logs",
"operationId": "prospectCommunicationHistory",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "only_activity",
"in": "query",
"schema": {
"type": "boolean",
"example": "true"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/CommunicationHistoryResource"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects": {
"get": {
"tags": [
"Prospects"
],
"summary": "List prospects",
"description": "Returns a list of all prospect for current user",
"operationId": "prospectIndex",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search by name, email or phone number",
"schema": {
"type": "string",
"example": "john"
}
},
{
"name": "pipeline_stage",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "group",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"active",
"non-active",
"responded"
],
"example": "active"
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"name",
"tags",
"last_conversation",
"last_contact",
"campaign",
"campaign_join",
"team",
"assigned_to",
"quialified_status",
"status",
"conversationalist_id",
"created_at"
],
"example": "created_at"
}
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": [
"desc",
"asc"
],
"example": "desc"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Show prospect",
"description": "Returns a detailed data for selected prospect",
"operationId": "prospectShow",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"put": {
"tags": [
"Prospects"
],
"summary": "Update prospect",
"description": "Updates prospect data",
"operationId": "prospectUpdate",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"first_name"
],
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"phone": {
"type": "string",
"example": "1112223333"
},
"assigned_to": {
"type": "integer",
"example": "1"
},
"field_1": {
"type": "string",
"example": "field 1 value"
},
"field_2": {
"type": "string",
"example": "field 2 value"
},
"field_3": {
"type": "string",
"example": "field 3 value"
},
"field_4": {
"type": "string",
"example": "field 4 value"
},
"field_5": {
"type": "string",
"example": "field 5 value"
},
"birthday": {
"type": "string",
"example": "2022-01-01"
},
"address": {
"type": "string",
"example": "Street Name"
},
"prospect_state": {
"type": "string",
"example": "California"
},
"city": {
"type": "string",
"example": "Los Angeles"
},
"prospect_zip": {
"type": "string",
"example": "001122"
},
"fb_id": {
"type": "string",
"example": "123abc"
},
"tags[]": {
"type": "string",
"example": "tag-name"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"delete": {
"tags": [
"Prospects"
],
"summary": "Delete prospect",
"description": "Deletes user from the system",
"operationId": "prospectDelete",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Person has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/dnc": {
"post": {
"tags": [
"Prospects"
],
"summary": "DNC",
"description": "Updates the do-not-contact status",
"operationId": "prospectDnc",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"value"
],
"properties": {
"value": {
"type": "integer",
"example": "1"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/delete": {
"post": {
"tags": [
"Prospects"
],
"summary": "Delete bulk prospects",
"description": "Deletes users from the system",
"operationId": "prospectDeleteBulk",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"is_all": {
"type": "boolean",
"example": "false"
},
"show_all": {
"type": "boolean",
"example": "true"
},
"prospects[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "People have been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/status": {
"post": {
"tags": [
"Prospects"
],
"summary": "Prospect status",
"description": "Updates the prospect status",
"operationId": "prospectStatus",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"non-active",
"responded"
],
"example": "non-active"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/campaign/{campaign}": {
"post": {
"tags": [
"Campaigns"
],
"summary": "Change campaign",
"description": "Move prospect to selected campaign",
"operationId": "prospectCampaign",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "campaign",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "2"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/campaign/{campaign}": {
"post": {
"tags": [
"Campaigns"
],
"summary": "Create prospect",
"description": "Creates a prospect",
"operationId": "prospectStoreCampaignParam",
"parameters": [
{
"name": "campaign",
"in": "path",
"required": false,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"first_name"
],
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"phone": {
"type": "string",
"example": "1112223333"
},
"assigned_to": {
"type": "integer",
"example": "1"
},
"field_1": {
"type": "string",
"example": "field 1 value"
},
"field_2": {
"type": "string",
"example": "field 2 value"
},
"field_3": {
"type": "string",
"example": "field 3 value"
},
"field_4": {
"type": "string",
"example": "field 4 value"
},
"field_5": {
"type": "string",
"example": "field 5 value"
},
"birthday": {
"type": "string",
"example": "2022-01-01"
},
"address": {
"type": "string",
"example": "Street Name"
},
"prospect_state": {
"type": "string",
"example": "California"
},
"city": {
"type": "string",
"example": "Los Angeles"
},
"prospect_zip": {
"type": "string",
"example": "001122"
},
"fb_id": {
"type": "string",
"example": "123abc"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"422": {
"description": "Error: Incorrect data"
},
"500": {
"description": "Error: Error occurred while creating new person"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/pipeline/{pipelineStage}": {
"post": {
"tags": [
"Pipelines"
],
"summary": "Create prospect in pipeline stage",
"description": "Creates a prospect in pipeline stage",
"operationId": "prospectPipelineStore",
"parameters": [
{
"name": "pipelineStage",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"first_name"
],
"properties": {
"first_name": {
"type": "string",
"example": "John"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"email": {
"type": "string",
"example": "johndoe@example.com"
},
"phone": {
"type": "string",
"example": "1112223333"
},
"assigned_to": {
"type": "integer",
"example": "1"
},
"field_1": {
"type": "string",
"example": "field 1 value"
},
"field_2": {
"type": "string",
"example": "field 2 value"
},
"field_3": {
"type": "string",
"example": "field 3 value"
},
"field_4": {
"type": "string",
"example": "field 4 value"
},
"field_5": {
"type": "string",
"example": "field 5 value"
},
"birthday": {
"type": "string",
"example": "2022-01-01"
},
"address": {
"type": "string",
"example": "Street Name"
},
"prospect_state": {
"type": "string",
"example": "California"
},
"city": {
"type": "string",
"example": "Los Angeles"
},
"prospect_zip": {
"type": "string",
"example": "001122"
},
"fb_id": {
"type": "string",
"example": "123abc"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProspectResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"422": {
"description": "Error: Incorrect data"
},
"500": {
"description": "Error: Error occurred while creating new person"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/email": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send email",
"description": "Sends Email to the prospect",
"operationId": "prospectEmailController",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"subject",
"message"
],
"properties": {
"subject": {
"type": "string",
"example": "Email subject"
},
"message": {
"type": "string",
"example": "Email message"
},
"attachments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "attachment_name",
"nullable": "false"
}
},
"type": "object"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/bulk/email": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send bulk email",
"description": "Send an email to multiple people",
"operationId": "prospectEmailControllerStoreBulk",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"subject",
"message"
],
"properties": {
"is_all": {
"type": "boolean",
"example": "false"
},
"show_all": {
"type": "boolean",
"example": "true"
},
"prospects[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
},
"subject": {
"type": "string",
"example": "Email subject"
},
"message": {
"type": "string",
"example": "Email message"
},
"attachments": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "attachment_name",
"nullable": "false"
}
},
"type": "object"
},
"collectionFormat": "multi"
},
"send_as": {
"type": "string",
"enum": [
"me",
"owner"
],
"example": "owner"
},
"send_at": {
"type": "string",
"example": "01/20/2030 10:00 am"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "All emails sent"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"422": {
"description": "You cannot broadcast to more than 5000 people at once."
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/share": {
"get": {
"tags": [
"Prospects"
],
"summary": "List shared users",
"description": "Returns a list of shared users for selected prospect",
"operationId": "prospectShareIndex",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSimpleResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"post": {
"tags": [
"Prospects"
],
"summary": "Store shared users",
"description": "Shares a prospect with selected users",
"operationId": "prospectShareStore",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"shared_user_ids[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSimpleResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/sms": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send SMS",
"description": "Sends SMS to the prospect",
"operationId": "prospectSmsControllerStore",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Sms message"
},
"attachment_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Prospect's phone number doesn't support SMS messages"
},
"500": {
"description": "Error: Couldn't send a message"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/bulk/sms": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send bulk SMS",
"description": "Send a SMS to multiple people",
"operationId": "prospectSmsControllerStoreBulk",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"message"
],
"properties": {
"is_all": {
"type": "boolean",
"example": "false"
},
"show_all": {
"type": "boolean",
"example": "true"
},
"prospects[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
},
"message": {
"type": "string",
"example": "Sms message"
},
"attachment_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128"
},
"send_as": {
"type": "string",
"enum": [
"me",
"owner"
],
"example": "owner"
},
"send_at": {
"type": "string",
"example": "01/20/2030 10:00 am"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "All messages sent"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"422": {
"description": "You cannot broadcast to more than 5000 people at once."
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/tags": {
"get": {
"tags": [
"User"
],
"summary": "List tags",
"description": "Returns list of all prospect-tags for current user",
"operationId": "prospectTag",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/quick-replies": {
"get": {
"tags": [
"Messaging"
],
"summary": "Quick replies",
"description": "List quick replies created by user",
"operationId": "quickRepliesIndex",
"parameters": [
{
"name": "type",
"in": "query",
"description": "1 - prospect message, 2 - campaign",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"quick_replies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuickReplyResource"
}
},
"shared": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuickReplyResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/quick-replies/{type}": {
"post": {
"tags": [
"Messaging"
],
"summary": "Create quick reply",
"description": "Creates a messaging template",
"operationId": "quickReplyStore",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"sms",
"email"
],
"example": "sms"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"title"
],
"properties": {
"title": {
"type": "string",
"example": "Quick reply title"
},
"content": {
"type": "string",
"example": "Quick reply content"
},
"html_content": {
"type": "string",
"example": "Quick reply HTML content"
},
"subject": {
"type": "string",
"example": "Quick reply subject"
},
"industry_tag": {
"type": "string",
"example": "Industry tag"
},
"type": {
"description": "1 - prospect message, 2 - campaign",
"type": "integer",
"example": "1"
},
"shared": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/QuickReplyResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/quick-replies/{type}/{quickReply}": {
"put": {
"tags": [
"Messaging"
],
"summary": "Update quick reply",
"description": "Updates a messaging template",
"operationId": "quickReplyUpdate",
"parameters": [
{
"name": "type",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"sms",
"email"
],
"example": "sms"
}
},
{
"name": "quickReply",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"title"
],
"properties": {
"title": {
"type": "string",
"example": "Quick reply title"
},
"content": {
"type": "string",
"example": "Quick reply content"
},
"html_content": {
"type": "string",
"example": "Quick reply HTML content"
},
"subject": {
"type": "string",
"example": "Quick reply subject"
},
"industry_tag": {
"type": "string",
"example": "Industry tag"
},
"type": {
"description": "1 - prospect message, 2 - campaign",
"type": "integer",
"example": "1"
},
"shared": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/QuickReplyResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/quick-replies/{quickReply}": {
"delete": {
"tags": [
"Messaging"
],
"summary": "Delete quick reply",
"description": "Deletes a messaging template",
"operationId": "quickReplyDelete",
"parameters": [
{
"name": "quickReply",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Quick reply has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/attachments/sms": {
"post": {
"tags": [
"Messaging"
],
"summary": "Create SMS attachment",
"description": "Returns a link that can be passed to `Send SMS` endpoint",
"operationId": "smsAttachment",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"attachment"
],
"properties": {
"attachment": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"path": {
"type": "string",
"example": "https://via.placeholder.com/128x128"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/tasks/{task}/change-completion": {
"post": {
"tags": [
"User"
],
"summary": "Task completion",
"description": "Updates the completion of the task",
"operationId": "taskCompletion",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"completed"
],
"properties": {
"completed": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/tasks": {
"get": {
"tags": [
"User"
],
"summary": "List tasks",
"description": "Returns all of tasks assigned to current user",
"operationId": "taskIndex",
"parameters": [
{
"name": "prospect_id",
"in": "query",
"schema": {
"type": "integer",
"example": "10"
}
},
{
"name": "search",
"in": "query",
"description": "Search by title",
"schema": {
"type": "string",
"example": "Task title"
}
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"none",
"call",
"voicemail",
"follow_up",
"meeting",
"birthday"
],
"example": "call"
}
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"today",
"active",
"upcoming",
"overdue",
"completed",
"birthday",
"current"
],
"example": "active"
}
},
{
"name": "conversationalist",
"in": "query",
"schema": {
"type": "boolean",
"example": false
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"title",
"details",
"type",
"assignee_id",
"business_id",
"prospect_id",
"date"
],
"example": "title"
}
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": [
"desc",
"asc"
],
"example": "desc"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "no_paginate",
"in": "query",
"schema": {
"type": "boolean",
"example": []
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/tasks/{task}": {
"get": {
"tags": [
"User"
],
"summary": "Task details",
"description": "Returns detailed data on a task",
"operationId": "taskShow",
"parameters": [
{
"name": "task",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/TaskResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/me": {
"get": {
"tags": [
"User"
],
"summary": "Get user details",
"description": "Returns details of currently authenticated user",
"operationId": "userIndex",
"responses": {
"200": {
"description": "Success.",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/AuthUserResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized."
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/team/members": {
"get": {
"tags": [
"User"
],
"summary": "List team members",
"description": "Returns details of all users within a team",
"operationId": "userList",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Search by name",
"schema": {
"type": "string",
"example": "John Doe"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "no_paginate",
"in": "query",
"schema": {
"type": "boolean",
"example": []
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized."
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/device": {
"post": {
"tags": [
"User"
],
"summary": "Add device token (internal)",
"description": "Adds device token to listen to FCM communications",
"operationId": "prospectDevice",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"device_token"
],
"properties": {
"device_token": {
"type": "string",
"example": "android:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
},
"os_type": {
"type": "string",
"example": "ios"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Device token added"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
},
"422": {
"description": "Error: Incorrect data"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/videos": {
"get": {
"tags": [
"User"
],
"summary": "List videos",
"description": "Returns all videos created by current user",
"operationId": "videoIndex",
"parameters": [
{
"name": "search",
"in": "query",
"schema": {
"type": "string",
"example": "Video title"
}
},
{
"name": "tab",
"in": "query",
"schema": {
"type": "string",
"enum": [
"team"
],
"example": "{}"
}
},
{
"name": "is_all",
"in": "query",
"schema": {
"type": "string",
"example": "1"
}
},
{
"name": "excluded[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"example": "0a1b3c"
}
}
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string",
"enum": [
"creator",
"titile",
"sort",
"views",
"cta_clicks",
"published_at"
],
"example": "published_at"
}
},
{
"name": "order",
"in": "query",
"schema": {
"type": "string",
"enum": [
"desc",
"asc"
],
"example": "desc"
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"example": "15"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"example": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoResource"
}
},
"links": {
"$ref": "#/components/schemas/Links"
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"post": {
"tags": [
"User"
],
"summary": "Store video",
"description": "Store a video file",
"operationId": "videoStore",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"video_file"
],
"properties": {
"video_file": {
"type": "string",
"format": "binary"
},
"folder_id": {
"type": "integer",
"example": "1"
},
"is_mms": {
"type": "boolean",
"example": "false"
},
"is_recorded": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/VideoResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/videos/{video}": {
"post": {
"tags": [
"User"
],
"summary": "Update video",
"description": "Update a video information",
"operationId": "videoUpdate",
"parameters": [
{
"name": "video",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1Ab23"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"required": [
"title"
],
"properties": {
"title": {
"type": "string",
"example": "Video title"
},
"personalized_title": {
"type": "string",
"example": "Personalized title"
},
"description": {
"type": "string",
"example": "Video description"
},
"calendly_link": {
"type": "string",
"example": "https://example.com"
},
"comments_enabled": {
"type": "boolean",
"example": "true"
},
"cta_link": {
"type": "string",
"example": "https://example.com"
},
"cta_text": {
"type": "string",
"example": "Go to my website"
},
"cta_color": {
"type": "string",
"example": "#EE3696"
},
"offset_start": {
"type": "integer",
"example": "60"
},
"offset_stop": {
"type": "integer",
"example": "120"
},
"transcription_enabled": {
"type": "boolean",
"example": "false"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/VideoResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
},
"delete": {
"tags": [
"User"
],
"summary": "Delete video",
"description": "Deletes a video",
"operationId": "videoDelete",
"parameters": [
{
"name": "video",
"in": "path",
"required": true,
"schema": {
"type": "string",
"example": "1Ab23"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"archive": {
"type": "boolean",
"example": "false"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Video has been deleted"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/{prospect}/voicemail/{voicemail}": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send voicemail",
"description": "Sends voicemail to the prospect",
"operationId": "voicemailMessageStore",
"parameters": [
{
"name": "prospect",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
},
{
"name": "voicemail",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"send_as": {
"type": "string",
"enum": [
"me",
"owner"
],
"example": "owner"
},
"send_at": {
"type": "string",
"example": "01/20/2030 10:00 am"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
},
"/prospects/bulk/voicemail/{voicemail}": {
"post": {
"tags": [
"Messaging"
],
"summary": "Send bulk voicemail",
"description": "Send a voicemail to multiple people",
"operationId": "voicemailMessageControllerStoreBulk",
"parameters": [
{
"name": "voicemail",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"example": "1"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"is_all": {
"type": "boolean",
"example": "false"
},
"show_all": {
"type": "boolean",
"example": "true"
},
"prospects[]": {
"type": "array",
"items": {
"type": "string",
"example": "1"
},
"collectionFormat": "multi"
},
"send_as": {
"type": "string",
"enum": [
"me",
"owner"
],
"example": "owner"
},
"send_at": {
"type": "string",
"example": "01/20/2030 10:00 am"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "All messages sent"
}
},
"type": "object"
}
}
}
},
"401": {
"description": "Error: Unauthorized"
}
},
"security": [
{
"apiAuth": []
}
]
}
}
},
"components": {
"schemas": {
"AuthUserResource": {
"title": "Authenticated User",
"description": "Extended resource of user, that includes private fields",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"parent_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"name": {
"type": "string",
"example": "John Doe",
"nullable": "false"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "false"
},
"phone_number": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"disabled": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"round_robin": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"campaign_phone_number": {
"type": "string",
"example": "+1222333444",
"nullable": "true"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "team_lead"
},
"nullable": "false"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"example": "reputation"
},
"nullable": "false"
},
"timezone": {
"type": "string",
"example": "America/New_York",
"nullable": "false"
},
"local_timezone": {
"type": "string",
"example": "America/Chicago",
"nullable": "false"
},
"has_conversationalist": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"last_login_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"email_verified_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"phone_verified_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"created_at_timestamp": {
"type": "integer",
"example": "1640998800",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"deleted_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"must_change_password": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"internal_permissions": {
"properties": {
"campaigns.manage": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"pipelines.manage": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"prospects.export": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"prospects.delete": {
"type": "boolean",
"example": "true",
"nullable": "false"
}
},
"type": "object",
"nullable": "false"
},
"business": {
"$ref": "#/components/schemas/BusinessResource"
}
},
"type": "object"
},
"BusinessAddressResource": {
"title": "Business Address",
"description": "Resource describing the HQ of a business",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"country_code": {
"type": "string",
"example": "us",
"nullable": "true"
},
"street": {
"type": "string",
"example": "Street Name",
"nullable": "true"
},
"city": {
"type": "string",
"example": "Los Angeles",
"nullable": "true"
},
"postal": {
"type": "string",
"example": "001122",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"BusinessResource": {
"title": "Business",
"description": "Resource describing the Business - wrapper for multiple users",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"parent_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"independent_billing": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Business Name",
"nullable": "false"
},
"address": {
"$ref": "#/components/schemas/BusinessAddressResource"
},
"sequence_timezone": {
"type": "string",
"example": "America/New_York",
"nullable": "false"
},
"custom_fields": {
"type": "array",
"items": {
"type": "string",
"example": "custom_field_1"
},
"nullable": "false"
},
"trial_ends_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"logo_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"setup_fee_paid": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"has_insurance": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"has_mortgage": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"has_recruiting": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "mortgage"
},
"nullable": "false"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"example": "access_pipelines"
},
"nullable": "false"
},
"incoming_call_prospect_owner": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"hide_prospect_source": {
"type": "boolean",
"example": "false",
"nullable": "false"
}
},
"type": "object"
},
"CampaignResource": {
"title": "Campaign",
"description": "Campaign resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Campaign name",
"nullable": "false"
},
"lead_zapier_uuid": {
"type": "string",
"example": "012a345b-1abc-1234-1a2b-1223456ab789c",
"nullable": "true"
},
"prospects_count": {
"type": "integer",
"example": "8",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"sequence": {
"$ref": "#/components/schemas/SequenceResource"
}
},
"type": "object"
},
"ChatMemberResource": {
"title": "Chat member",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "false"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"name": {
"type": "string",
"example": "John Doe",
"nullable": "false"
}
},
"type": "object"
},
"ChatMessageResource": {
"title": "Chat message resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"chat_room_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"content": {
"type": "string",
"example": "Message content",
"nullable": "false"
},
"sender_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"sender": {
"$ref": "#/components/schemas/ChatMemberResource"
},
"attachment": {
"$ref": "#/components/schemas/FileSimpleResource"
},
"reaction": {
"$ref": "#/components/schemas/ReactionResource"
}
},
"type": "object"
},
"ChatRoomResource": {
"title": "Chat room resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Chat room name",
"nullable": "false"
},
"type": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"owner_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"new_messages": {
"type": "integer",
"example": "3",
"nullable": "true"
},
"topic": {
"type": "string",
"example": "Chat room topic",
"nullable": "true"
},
"description": {
"type": "string",
"example": "Chat room description",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMemberResource"
},
"nullable": "true"
},
"owner": {
"$ref": "#/components/schemas/UserSimpleResource"
}
},
"type": "object"
},
"CommunicationHistoryResource": {
"title": "Communication History",
"description": "Resource listing messages and activities in conversation",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"user_id": {
"type": "string",
"example": "3",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"status": {
"type": "string",
"example": "delivered",
"nullable": "true"
},
"audio_path": {
"type": "string",
"example": "https://example.com",
"nullable": "true"
},
"image_path": {
"type": "string",
"example": "Parsed json array",
"nullable": "true"
},
"sequence_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"subject": {
"type": "string",
"example": "Message subject",
"nullable": "true"
},
"content": {
"type": "string",
"example": "Message content",
"nullable": "true"
},
"type": {
"type": "string",
"example": "email",
"nullable": "true"
},
"conversationalist_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"direction": {
"type": "string",
"example": "outgoing",
"nullable": "true"
},
"event_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"pipeline_event_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"source": {
"type": "string",
"example": "direct",
"nullable": "true"
},
"user_name": {
"type": "string",
"example": "John Doe",
"nullable": "true"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"error_message": {
"type": "string",
"example": "Error message",
"nullable": "true"
},
"send_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"event_date": {
"type": "string",
"example": "2022-01-01 01:00:00",
"nullable": "true"
}
},
"type": "object"
},
"ContactInformationResource": {
"title": "Contact Information",
"description": "Resource listing secondary conversation",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"type": {
"type": "string",
"example": "email",
"nullable": "false"
},
"content": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "false"
},
"phone_type": {
"type": "string",
"example": "valid",
"nullable": "true"
},
"email_type": {
"type": "string",
"example": "valid",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"CustomFieldResource": {
"title": "Custom field",
"description": "Custom fields resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"group_id": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"label": {
"type": "string",
"example": "Nickname",
"nullable": "false"
},
"label_normalized": {
"type": "string",
"example": "nickname",
"nullable": "true"
},
"help_text": {
"type": "string",
"example": "Prospect nickname",
"nullable": "true"
},
"order": {
"type": "integer",
"example": "0",
"nullable": "false"
},
"type": {
"type": "string",
"example": "text",
"nullable": "false"
},
"details": {
"example": null,
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"FieldGroupResource": {
"title": "Field group",
"description": "Field groups resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"template_tag": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"name": {
"type": "string",
"example": "My custom field group",
"nullable": "false"
},
"order": {
"type": "integer",
"example": "0",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldResource"
},
"nullable": "true"
}
},
"type": "object"
},
"FileSimpleResource": {
"title": "File resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"display_name": {
"example": "my_avatar",
"nullable": "string"
},
"mime_type": {
"type": "string",
"example": "image/jpeg",
"nullable": "false"
},
"disk": {
"type": "string",
"example": "s3",
"nullable": "false"
},
"private": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"size": {
"type": "integer",
"example": "18925",
"nullable": "false"
},
"url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"additional_data": {
"type": "string",
"example": "null",
"nullable": "true"
},
"extension": {
"type": "string",
"example": "jpg",
"nullable": "false"
}
},
"type": "object"
},
"InsuranceFields": {
"title": "Insurance Fields",
"description": "Resource listing all insurance-specific fields",
"properties": {
"prospect_id": {
"type": "string",
"example": "1",
"nullable": "false"
},
"referral_source": {
"type": "string",
"example": "Zapier",
"nullable": "true"
},
"company_name": {
"type": "string",
"example": "Platypus Industries",
"nullable": "true"
},
"zip": {
"type": "string",
"example": "10001",
"nullable": "true"
},
"insurance_city": {
"type": "string",
"example": "New York",
"nullable": "true"
},
"insurance_state": {
"type": "string",
"example": "NY",
"nullable": "true"
},
"insurance_address": {
"type": "string",
"example": "Example street 10",
"nullable": "true"
},
"birthday": {
"type": "string",
"example": "1970-01-01",
"nullable": "true"
},
"apartment_number": {
"type": "string",
"example": "10",
"nullable": "true"
},
"marital_status": {
"type": "string",
"example": "married",
"nullable": "true"
},
"height": {
"type": "string",
"example": "180cm",
"nullable": "true"
},
"weight": {
"type": "string",
"example": "160lb",
"nullable": "true"
},
"weight_change": {
"type": "integer",
"example": "+50lb",
"nullable": "true"
},
"income": {
"type": "string",
"example": "$2000000",
"nullable": "true"
},
"occupation": {
"type": "string",
"example": "Programmer",
"nullable": "true"
},
"work_phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"net_worth": {
"type": "string",
"example": "$750000",
"nullable": "true"
},
"insurance_declined": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"gender": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"dependents": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"smoker": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"credit_standing": {
"type": "string",
"example": "$50000",
"nullable": "true"
},
"flood_interest": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"earthquake_interest": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"deductible": {
"type": "string",
"example": "$50000",
"nullable": "true"
},
"coverage_amount": {
"type": "string",
"example": "$200000",
"nullable": "true"
},
"liability_amount": {
"type": "string",
"example": "$500000",
"nullable": "true"
},
"dui": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"occupancy_status": {
"type": "string",
"example": "occupancy_status",
"nullable": "true"
},
"property_use": {
"type": "string",
"example": "house",
"nullable": "true"
},
"property_type": {
"type": "string",
"example": "single home",
"nullable": "true"
},
"license_status": {
"type": "string",
"example": "license_status",
"nullable": "true"
}
},
"type": "object"
},
"Links": {
"title": "Links",
"description": "Resource for pagination links",
"properties": {
"first": {
"type": "string",
"example": "https://example.com?page=1",
"nullable": "false"
},
"last": {
"type": "string",
"example": "https://example.com?page=3",
"nullable": "false"
},
"prev": {
"type": "string",
"example": null,
"nullable": "true"
},
"next": {
"type": "string",
"example": "https://example.com?page=2",
"nullable": "true"
}
},
"type": "object"
},
"MergeTagResource": {
"title": "Merge Tag",
"description": "Resource describing Merge Tags - dynamic fields to be used in conversation",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"user_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Custom website",
"nullable": "false"
},
"value": {
"type": "string",
"example": "https://example.com",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"MessageResource": {
"title": "Message",
"description": "Message Resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"campaign_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"prospect_id": {
"type": "integer",
"example": "3",
"nullable": "prospect_id"
},
"prospect": {
"$ref": "#/components/schemas/ProspectSimpleResource"
},
"type": {
"type": "string",
"example": "email",
"nullable": "true"
},
"content": {
"type": "string",
"example": "Message content",
"nullable": "false"
},
"subject": {
"type": "string",
"example": "Message subject",
"nullable": "true"
},
"source": {
"type": "string",
"example": "direct",
"nullable": "true"
},
"status": {
"type": "string",
"example": "deliered",
"nullable": "false"
},
"direction": {
"type": "string",
"example": "outging",
"nullable": "true"
},
"user_name": {
"type": "string",
"example": "John Doe",
"nullable": "true"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"event_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"error_message": {
"type": "string",
"example": "Example error message",
"nullable": "true"
},
"image_path": {
"type": "string",
"example": "Parsed json array",
"nullable": "true"
},
"audio_path": {
"type": "string",
"example": "https://example.com",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"send_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"conversationalist_id": {
"type": "integer",
"example": "1",
"nullable": "true"
}
},
"type": "object"
},
"Meta": {
"title": "Meta",
"description": "Describing miscelanious fields, like current page",
"properties": {
"current_page": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"from": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"last_page": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"links": {
"type": "array",
"items": {
"properties": {
"url": {
"type": "string",
"nullable": "true"
},
"label": {
"type": "string",
"nullable": "true"
},
"active": {
"type": "boolean",
"nullable": "false"
}
},
"type": "object"
},
"example": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://example.com?page=1",
"label": 1,
"active": true
},
{
"url": "https://example.com?page=2",
"label": 2,
"active": false
},
{
"url": "https://example.com?page=2",
"label": "Next »",
"active": false
}
]
},
"path": {
"type": "string",
"example": "https://example.com",
"nullable": "false"
},
"per_page": {
"type": "integer",
"example": "25",
"nullable": "false"
},
"to": {
"type": "integer",
"example": "25",
"nullable": "true"
},
"total": {
"type": "integer",
"example": "70",
"nullable": "false"
}
},
"type": "object"
},
"MortgageFields": {
"title": "Mortgage Fields",
"description": "Resource listing all mortgage-specific fields",
"properties": {
"prospect_id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"lead_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"company_name": {
"type": "string",
"example": "company_name",
"nullable": "true"
},
"birthday": {
"type": "string",
"example": "birthday",
"nullable": "true"
},
"zip": {
"type": "string",
"example": "zip",
"nullable": "true"
},
"loan_amount": {
"type": "string",
"example": "$425000",
"nullable": "true"
},
"down_payment": {
"type": "string",
"example": "$125000",
"nullable": "true"
},
"loan_program": {
"type": "string",
"example": "25yr",
"nullable": "true"
},
"credit_score": {
"type": "string",
"example": "750",
"nullable": "true"
},
"loan_type": {
"type": "string",
"example": "fixed",
"nullable": "true"
},
"loan_purpose": {
"type": "string",
"example": "loan_purpose",
"nullable": "true"
},
"property_value": {
"type": "string",
"example": "$550000",
"nullable": "true"
},
"property_address": {
"type": "string",
"example": "Example street 10",
"nullable": "true"
},
"property_unit_number": {
"type": "string",
"example": "7",
"nullable": "true"
},
"property_city": {
"type": "string",
"example": "NYC",
"nullable": "true"
},
"property_state": {
"type": "string",
"example": "New York State",
"nullable": "true"
},
"property_zip": {
"type": "string",
"example": "10001",
"nullable": "true"
},
"property_county": {
"type": "string",
"example": "Queens",
"nullable": "true"
},
"found_home": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"bankruptcy": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"foreclosure": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"working_with_agent": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"agent_name": {
"type": "string",
"example": "John Doe",
"nullable": "true"
},
"lead_source": {
"type": "string",
"example": "Bonzo",
"nullable": "true"
},
"interest_rate": {
"type": "string",
"example": "3.5",
"nullable": "true"
},
"requested_apr": {
"type": "string",
"example": "4.5",
"nullable": "true"
},
"property_type": {
"type": "string",
"example": "single home",
"nullable": "true"
},
"property_use": {
"type": "string",
"example": "house",
"nullable": "true"
},
"bankruptcy_details": {
"type": "string",
"example": "none",
"nullable": "true"
},
"foreclosure_details": {
"type": "integer",
"example": "none",
"nullable": "true"
},
"occupation": {
"type": "string",
"example": "Programmer",
"nullable": "true"
},
"household_income": {
"type": "string",
"example": "$250k+",
"nullable": "true"
},
"current_step": {
"type": "string",
"example": "looking for home",
"nullable": "true"
},
"purchase_price": {
"type": "string",
"example": "purchase_price",
"nullable": "true"
},
"cash_out_amount": {
"type": "string",
"example": "cash_out_amount",
"nullable": "true"
},
"application_date": {
"type": "string",
"example": "01/20/2022",
"nullable": "true"
},
"close_date": {
"type": "string",
"example": "2022-01-20",
"nullable": "true"
}
},
"type": "object"
},
"NoteResource": {
"title": "Notes",
"description": "Prospect notes",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"user_id": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"content": {
"type": "string",
"example": "Example note content",
"nullable": "false"
},
"is_pinned": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"include_in_conversation": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"user": {
"$ref": "#/components/schemas/UserSimpleResource"
}
},
"type": "object"
},
"NotificationResource": {
"title": "Notification",
"description": "Describing notification",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"type": {
"type": "string",
"example": "4",
"nullable": "false"
},
"tyype_name": {
"type": "string",
"example": "ProspectNew",
"nullable": "true"
},
"title": {
"type": "string",
"example": "John Doe has been created by webhook",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"read_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"PipelineResource": {
"title": "Pipeline",
"description": "Resource describing pipeline",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"business": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Business name",
"nullable": "false"
}
},
"type": "object",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Pipeline name",
"nullable": "false"
},
"description": {
"type": "string",
"example": "Pipeline descripiton.",
"nullable": "true"
},
"order": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"is_default": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"is_template": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"business_tag": {
"type": "string",
"example": "mortgage",
"nullable": "true"
},
"start": {
"type": "string",
"example": "09:00:00",
"nullable": "false"
},
"end": {
"type": "string",
"example": "17:00:00",
"nullable": "false"
},
"enabled_days": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
0,
1,
2,
3,
4
],
"nullable": "false"
},
"is_today_excluded": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"local_timezone": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"exclude_national_holidays": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"disclaimer_disabled": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"prospects_count": {
"type": "integer",
"example": "10",
"nullable": "true"
},
"stages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PipelineStageResource"
},
"nullable": "true"
},
"stages_count": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"cover_url": {
"type": "string",
"example": "https://example.com",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"PipelineStageResource": {
"title": "Pipeline Stage",
"description": "Resource describing stage in pipeline",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"pipeline_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Pipeline stage name",
"nullable": "false"
},
"color": {
"type": "string",
"example": "blue-50",
"nullable": "true"
},
"order": {
"type": "integer",
"example": "0",
"nullable": "false"
},
"prospect_count": {
"type": "integer",
"example": "3",
"nullable": "ture"
},
"events_count": {
"type": "integer",
"example": "5",
"nullable": "ture"
},
"campaign": {
"$ref": "#/components/schemas/CampaignResource"
},
"related_campaigns_count": {
"type": "integer",
"example": "0",
"nullable": "ture"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"ProspectConversationSidebarResource": {
"title": "Prospect Listing",
"description": "Resource describing simplified prospect resource for conversation listing",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"is_new": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"unread_messages_count": {
"type": "integer",
"example": "10",
"nullable": "true"
},
"conversation_hidden": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"conversationalist_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"avatar": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"full_name": {
"type": "string",
"example": "John Doe",
"nullable": "false"
},
"shared_users_count": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"do_not_call": {
"type": "boolean",
"example": "do_not_call",
"nullable": "false"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "true"
},
"email_type": {
"type": "string",
"example": "valid",
"nullable": "true"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"phone_type": {
"type": "string",
"example": "valid",
"nullable": "true"
},
"new_response": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"last_contact": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"took_over": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"last_outgoing_message": {
"type": "string",
"example": "Example message",
"nullable": "true"
},
"last_incoming_message": {
"type": "string",
"example": "Example message",
"nullable": "true"
}
},
"type": "object"
},
"ProspectCustomDetailsResource": {
"title": "Custom Details",
"description": "Resource describing custom fields saved to prospect",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"custom_field_id": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"body": {
"type": "string",
"example": "Custom field value",
"nullable": "true"
}
},
"type": "object"
},
"ProspectResource": {
"title": "Prospect",
"description": "Resource describing prospect",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"first_name": {
"type": "string",
"example": "John",
"nullable": "true"
},
"last_name": {
"type": "string",
"example": "Doe",
"nullable": "true"
},
"full_name": {
"type": "string",
"example": "John Doe",
"nullable": "true"
},
"avatar": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"source": {
"type": "string",
"example": "api",
"nullable": "true"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "true"
},
"email_type": {
"type": "string",
"example": "valid",
"nullable": "true"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"phone_type": {
"type": "string",
"example": "mobile",
"nullable": "true"
},
"status": {
"type": "string",
"example": "non-active",
"nullable": "true"
},
"address": {
"type": "string",
"example": "Street Name",
"nullable": "true"
},
"city": {
"type": "string",
"example": "Los Angeles",
"nullable": "true"
},
"birthday": {
"type": "string",
"example": "2022-01-01",
"nullable": "true"
},
"state": {
"type": "string",
"example": "California",
"nullable": "true"
},
"zip": {
"type": "string",
"example": "001122",
"nullable": "true"
},
"assigned_to": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"assigned_user": {
"$ref": "#/components/schemas/UserSimpleResource"
},
"do_not_call": {
"type": "boolean",
"example": false,
"nullable": "true"
},
"last_contact": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"last_conversation": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"last_subject": {
"type": "string",
"example": "Last subject",
"nullable": "true"
},
"timezone": {
"type": "string",
"example": "America/New_York",
"nullable": "true"
},
"field_1": {
"type": "string",
"example": "Custom field 1",
"nullable": "true"
},
"field_2": {
"type": "string",
"example": "Custom field 2",
"nullable": "true"
},
"field_3": {
"type": "string",
"example": "Custom field 3",
"nullable": "true"
},
"field_4": {
"type": "string",
"example": "Custom field 4",
"nullable": "true"
},
"field_5": {
"type": "string",
"example": "Custom field 5",
"nullable": "true"
},
"shared_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSimpleResource"
},
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"business": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Business name",
"nullable": "false"
}
},
"type": "object",
"nullable": "false"
},
"campaigns": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Campaign name",
"nullable": "false"
}
},
"type": "object"
},
"nullable": "true"
},
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Tag name",
"nullable": "false"
}
},
"type": "object"
},
"nullable": "true"
},
"conversationalist": {
"$ref": "#/components/schemas/UserSimpleResource"
},
"pipeline": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Pipeline name",
"nullable": "false"
}
},
"type": "object",
"nullable": "false"
},
"pipeline_stage": {
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Pipeline stage name",
"nullable": "false"
}
},
"type": "object",
"nullable": "false"
},
"custom_status": {
"$ref": "#/components/schemas/ProspectStatusResource"
},
"custom_sub_status": {
"$ref": "#/components/schemas/ProspectSubStatusResource"
},
"mortgage": {
"$ref": "#/components/schemas/MortgageFields"
},
"recruiting": {
"$ref": "#/components/schemas/RecruitingFields"
},
"insurance": {
"$ref": "#/components/schemas/InsuranceFields"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProspectCustomDetailsResource"
},
"nullable": "true"
},
"contact_information": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactInformationResource"
},
"nullable": "true"
}
},
"type": "object"
},
"ProspectSimpleResource": {
"title": "Prospect",
"description": "Resource describing prospect",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"full_name": {
"type": "string",
"example": "John Doe",
"nullable": "true"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "true"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"avatar": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
}
},
"type": "object"
},
"ProspectStatusResource": {
"title": "Prospect Status",
"description": "Resource describing prospect custom status",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Rejected",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"ProspectSubStatusResource": {
"title": "Prospect Sub Status",
"description": "Resource describing prospect custom sub status",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "Too low CS",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"QuickReplyResource": {
"title": "Quick Reply",
"description": "Resource describing response templates",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"user_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "3",
"nullable": "true"
},
"title": {
"type": "string",
"example": "Quick reply title",
"nullable": "false"
},
"content": {
"type": "string",
"example": "Quick reply content",
"nullable": "true"
},
"subject": {
"type": "string",
"example": "Quick reply subject",
"nullable": "true"
},
"html_content": {
"type": "string",
"example": "Quick reply HTML content",
"nullable": "true"
},
"shared": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"type": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"order": {
"type": "integer",
"example": "0",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"ReactionResource": {
"title": "Reaction resource",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"user_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"reaction": {
"type": "string",
"example": "thumb up",
"nullable": "false"
},
"user": {
"$ref": "#/components/schemas/UserSimpleResource"
}
},
"type": "object"
},
"RecruitingFields": {
"title": "Recruiting Fields",
"description": "Resource listing all recruiting-specific fields",
"properties": {
"prospect_id": {
"type": "string",
"example": "1",
"nullable": "false"
},
"job_title": {
"type": "string",
"example": "Job title",
"nullable": "true"
},
"company_name": {
"type": "string",
"example": "Company name",
"nullable": "true"
},
"linkedin_url": {
"type": "string",
"example": "https://example.com",
"nullable": "true"
},
"start_date": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"nmls": {
"type": "string",
"example": "nmls",
"nullable": "true"
},
"consumer_facing": {
"type": "string",
"example": "Consumer facing",
"nullable": "true"
},
"types_of_loan": {
"type": "string",
"example": "Types of loan",
"nullable": "true"
},
"volume_monetary": {
"type": "string",
"example": "Volume monetary",
"nullable": "true"
},
"volume_amount": {
"type": "string",
"example": "Volume amount",
"nullable": "true"
},
"software_utilized": {
"type": "string",
"example": "Software utilized",
"nullable": "true"
},
"lead_sources": {
"type": "string",
"example": "Lead sources",
"nullable": "true"
},
"state_licenses": {
"type": "string",
"example": "State licenses",
"nullable": "true"
},
"work_from_home": {
"type": "boolean",
"example": "1",
"nullable": "true"
},
"compensation_range": {
"type": "string",
"example": "Compensation range",
"nullable": "true"
}
},
"type": "object"
},
"SequenceResource": {
"title": "Sequence Resource",
"description": "Resource describing content of the campaign",
"properties": {
"name": {
"type": "string",
"example": "Sequence name",
"nullable": "false"
},
"campaign_id": {
"type": "string",
"example": "1",
"nullable": "true"
},
"enabled": {
"type": "boolean",
"example": true,
"nullable": "false"
},
"enable_date": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"type": {
"type": "string",
"example": "day_based",
"nullable": "false"
},
"prospect_zapier_uuid": {
"type": "string",
"example": "012a345b-1abc-1234-1a2b-1223456ab789c",
"nullable": "true"
},
"description": {
"type": "string",
"example": "Sequence description.",
"nullable": "true"
},
"locked": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"is_template": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"round_robin": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"stop_on_response": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"start_campaign": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"cutoff_start": {
"type": "string",
"example": "09:00:00",
"nullable": "false"
},
"cutoff_stop": {
"type": "string",
"example": "18:00:00",
"nullable": "false"
},
"replies": {
"type": "array",
"items": {
"properties": {
"forward_sms": {
"type": "boolean",
"example": "false",
"nullable": "false"
}
},
"type": "object"
},
"nullable": "false"
},
"loop": {
"type": "array",
"items": {
"properties": {
"delay": {
"type": "integer",
"example": "3",
"nullable": "true"
},
"campaign_id": {
"type": "integer",
"example": "1",
"nullable": "true"
}
},
"type": "object"
},
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"TagResource": {
"title": "Tag",
"description": "Describing prospect tags, used for easier filtration",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "vip",
"nullable": "false"
}
},
"type": "object"
},
"TaskItemResource": {
"title": "Task Items",
"description": "Resource describing task items",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"task_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"title": {
"type": "string",
"example": "Task item title",
"nullable": "false"
},
"order": {
"type": "integer",
"example": "0",
"nullable": "false"
},
"completed_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"TaskResource": {
"title": "Task",
"description": "Describing tasks - quick to-do reminders",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"prospect_id": {
"type": "integer",
"example": "2",
"nullable": "true"
},
"owner_id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "3",
"nullable": "false"
},
"assignee_id": {
"type": "integer",
"example": "3",
"nullable": "true"
},
"is_conversationalist": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"event_id": {
"type": "boolean",
"example": "5",
"nullable": "true"
},
"type": {
"type": "string",
"example": "call",
"nullable": "true"
},
"frequency": {
"type": "string",
"example": "monthly",
"nullable": "true"
},
"priority": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"date": {
"type": "string",
"example": "2022-01-01",
"nullable": "false"
},
"time": {
"type": "string",
"example": "09:00:00",
"nullable": "false"
},
"title": {
"type": "string",
"example": "Task title",
"nullable": "false"
},
"details": {
"type": "string",
"example": "Additional information about the task.",
"nullable": "true"
},
"remind_before": {
"type": "integer",
"example": "1440",
"nullable": "true"
},
"calendar_sync": {
"type": "boolean",
"example": "false",
"nullable": "true"
},
"length": {
"type": "integer",
"example": "15",
"nullable": "false"
},
"notification_channels": {
"type": "string",
"example": "email",
"nullable": "true"
},
"completed_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"assignee": {
"$ref": "#/components/schemas/UserSimpleResource"
},
"prospect": {
"$ref": "#/components/schemas/ProspectSimpleResource"
},
"owner": {
"$ref": "#/components/schemas/UserSimpleResource"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskItemResource"
},
"nullable": "true"
}
},
"type": "object"
},
"UserResource": {
"title": "User Resource",
"description": "Describing user",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "1",
"nullable": "true"
},
"name": {
"type": "string",
"example": "John Doe",
"nullable": "false"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "false"
},
"phone_number": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"disabled": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"round_robin": {
"type": "boolean",
"example": "false",
"nullable": "false"
},
"campaign_phone_number": {
"type": "string",
"example": "+1222333444",
"nullable": "true"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
},
"calendly_link": {
"type": "string",
"example": "https://example.com",
"nullable": "true"
},
"last_login_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"email_verified_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"phone_verified_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"created_at_timestamp": {
"type": "integer",
"example": "1640998800",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"deleted_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
}
},
"type": "object"
},
"UserSimpleResource": {
"title": "User Simple Resource",
"description": "Describing users, for listing",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"name": {
"type": "string",
"example": "John Doe",
"nullable": "false"
},
"email": {
"type": "string",
"example": "johndoe@example.com",
"nullable": "false"
},
"phone": {
"type": "string",
"example": "1112223333",
"nullable": "true"
},
"avatar_url": {
"type": "string",
"example": "https://via.placeholder.com/128x128",
"nullable": "true"
}
},
"type": "object"
},
"VideoResource": {
"title": "Video Resource",
"description": "Describing in-app videos",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"uuid": {
"type": "string",
"example": "0a1b3c",
"nullable": "false"
},
"title": {
"type": "string",
"example": "Video titile",
"nullable": "true"
},
"personalized_title": {
"type": "string",
"example": "Personalized title",
"nullable": "true"
},
"status": {
"type": "string",
"example": "processed",
"nullable": "false"
},
"views": {
"type": "integer",
"example": "10",
"nullable": "false"
},
"watch_url": {
"type": "string",
"example": "https://example.com",
"nullable": "false"
},
"thumbnail_url": {
"type": "string",
"example": "https://example.com/image.gif",
"nullable": "false"
},
"still_url": {
"type": "string",
"example": "https://example.com/image.png",
"nullable": "false"
},
"video_url": {
"type": "string",
"example": "https://example.com",
"nullable": "false"
},
"mms_compatible": {
"type": "boolean",
"example": "true",
"nullable": "false"
},
"published_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "true"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
},
"VoicemailResource": {
"title": "TODO title",
"description": "TODO description",
"properties": {
"id": {
"type": "integer",
"example": "1",
"nullable": "false"
},
"user_id": {
"type": "integer",
"example": "2",
"nullable": "false"
},
"business_id": {
"type": "integer",
"example": "3",
"nullable": "true"
},
"friendly_name": {
"type": "string",
"example": "My_voicemail",
"nullable": "true"
},
"file_name": {
"type": "string",
"example": "9IKXCSRceGqO.mp3",
"nullable": "false"
},
"type": {
"type": "string",
"example": "broadcast",
"nullable": "false"
},
"is_visible": {
"type": "boolean",
"example": "true",
"nullable": ""
},
"url": {
"type": "string",
"example": "https://example.com",
"nullable": "false"
},
"created_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
},
"updated_at": {
"type": "string",
"example": "2022-01-01T01:00:00.000000Z",
"nullable": "false"
}
},
"type": "object"
}
},
"securitySchemes": {
"apiAuth": {
"type": "http",
"description": "http-releted endpoints",
"name": "Token based Based",
"in": "header",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
},
"tags": [
{
"name": "User",
"description": "User-releted endpoints"
},
{
"name": "Prospects",
"description": "Prospects-releted endpoints"
},
{
"name": "Messaging",
"description": "Messaging-releted endpoints"
},
{
"name": "Chat",
"description": "Chat-releted endpoints"
},
{
"name": "Campaigns",
"description": "Campaigns-releted endpoints"
},
{
"name": "Pipelines",
"description": "Pipelines-releted endpoints"
}
]
}