API falecomigo.ai
Referência da API da falecomigo.ai: autenticação, atendimento, disparos, CRM, integrações e recursos da plataforma.
Visão geral e autenticação
Todas as chamadas usam HTTPS e JSON, com o token de API da sua organização no cabeçalho Authorization. Gere o token dentro da plataforma, nas configurações de API da organização, e guarde-o como segredo: ele age em nome da organização.
Gere sua chave em Minha Organização, na aba API Tokens. As permissões das chamadas seguem o nível de acesso do token.
183 operações organizadas por área.
basehttps://api.falecomigo.ai
Cabeçalhos
AuthorizationstringobrigatórioBearer <token de API da organização>.
Content-Typestringapplication/json nas chamadas com corpo.
Core/Auth
Me
gethttps://api.falecomigo.ai/api/auth/me
Cabeçalhos
Content-TypestringobrigatórioAuthorizationstringobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Me",
"deprecated": false,
"description": "",
"tags": [
"Core/Auth"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer TOKEN_DE_EXEMPLO",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Core/Auth",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-28009084-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/auth/me"
200
{}Core/Auth
Login
Utilize essa rota para obter o token de autenticação para utilizar nas rotas que exigem autenticação.
posthttps://api.falecomigo.ai/api/auth/login
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Login",
"deprecated": false,
"description": "Utilize essa rota para obter o token de autenticação para utilizar nas rotas que exigem autenticação.",
"tags": [
"Core/Auth"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
},
"example": {
"email": "email@test.com",
"password": "PASSWORD"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Auth",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494468-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/auth/login" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "email@test.com",
"password": "PASSWORD"
}'200
{}Core/Auth
Verify token
gethttps://api.falecomigo.ai/api/auth/verify
Cabeçalhos
Content-TypestringobrigatórioAuthorizationstringobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Verify token",
"deprecated": false,
"description": "",
"tags": [
"Core/Auth"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer TOKEN_DE_EXEMPLO",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Core/Auth",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494469-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/auth/verify"
200
{}Core/Access Level
Invite new user
posthttps://api.falecomigo.ai/access-management/organizations/{organization_id}/invite
Parâmetros de caminho
organization_idstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioCorpo
emailstringobrigatóriofirstNamestringobrigatóriocustomerTypestringobrigatóriorolestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Invite new user",
"deprecated": false,
"description": "",
"tags": [
"Core/Access Level"
],
"parameters": [
{
"name": "organization_id",
"in": "path",
"description": "",
"required": true,
"example": "3d9ec732-2165-49a5-aed7-8760274f1602",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"customerType": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"email",
"firstName",
"customerType",
"role"
],
"x-apidog-orders": [
"email",
"firstName",
"customerType",
"role"
],
"x-apidog-ignore-properties": []
},
"example": {
"email": "bewhalewell@gmail.com",
"firstName": "Sam",
"customerType": "PF",
"role": "admin"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Access Level",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494459-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/access-management/organizations/{organization_id}/invite" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "bewhalewell@gmail.com",
"firstName": "Sam",
"customerType": "PF",
"role": "admin"
}'200
{}Core/Organization
Stats
gethttps://api.falecomigo.ai/organizations/stats
Parâmetros de consulta
searchstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Stats",
"deprecated": false,
"description": "",
"tags": [
"Core/Organization"
],
"parameters": [
{
"name": "search",
"in": "query",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Organization",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16816772-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/organizations/stats?search=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Core/Organization
Settings
gethttps://api.falecomigo.ai/api/organization/settings
Parâmetros de consulta
searchstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Settings",
"deprecated": false,
"description": "",
"tags": [
"Core/Organization"
],
"parameters": [
{
"name": "search",
"in": "query",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Organization",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18809069-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/organization/settings?search=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Core/Organization
Get Organization by ID
gethttps://api.falecomigo.ai/api/organizations/{id}
Parâmetros de caminho
idstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Organization by ID",
"deprecated": false,
"description": "",
"tags": [
"Core/Organization"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "75972401-c9ca-4748-bc34-103f8312a9e5",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Organization",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494512-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/organizations/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Core/Organization
Get All Customers
gethttps://api.falecomigo.ai/api/customers/organization
Parâmetros de consulta
searchstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get All Customers",
"deprecated": false,
"description": "",
"tags": [
"Core/Organization"
],
"parameters": [
{
"name": "search",
"in": "query",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Core/Organization",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-21036723-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/customers/organization?search=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Chat/Campaign
Campaign Shootings
gethttps://api.falecomigo.ai/api/campaigns/{campaignId}
Parâmetros de caminho
campaignIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Campaign Shootings",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Campaign"
],
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "",
"required": true,
"example": "375a58b4-486a-4662-ab9d-789052bf0bae",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Campaign",
"x-apidog-status": "developing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16813347-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/campaigns/{campaignId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Chat/Campaign
Show Shooting
gethttps://api.falecomigo.ai/api/shootings/{shootingId}
Parâmetros de caminho
shootingIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show Shooting",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Campaign"
],
"parameters": [
{
"name": "shootingId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Campaign",
"x-apidog-status": "developing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-27713540-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/shootings/{shootingId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Chat/Campaign
List all
gethttps://api.falecomigo.ai/campaigns
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List all",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Campaign"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Campaign",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494479-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/campaigns" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Chat/Message
Create
posthttps://api.falecomigo.ai/api/messages
Corpo
sessionIdstringobrigatóriotype"MEDIA" | "TEXT" | "RECORDING" | "CHAT_COMMAND"obrigatóriodirection"IN" | "OUT"obrigatórioauthor"CUSTOMER" | "AGENT" | "AGENT_PLATFORM" | "AI" | "BUSINESS" | "SYSTEM"obrigatóriocontentanyobrigatóriopauseSessionbooleanstatus"PENDING" | "SENT" | "DELIVERED" | "READ" | "FAILED"externalIdstringsendExternalMessagebooleanIf true, it will send a message to the client. If false, it will only record the message in the database.
customerIdstringdepartmentIdstringquotedMessageIdstringmetadataobjectAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Message"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"MEDIA",
"TEXT",
"RECORDING",
"CHAT_COMMAND"
],
"x-apidog-enum": [
{
"value": "MEDIA",
"name": "MEDIA",
"description": ""
},
{
"value": "TEXT",
"name": "TEXT",
"description": ""
},
{
"value": "RECORDING",
"name": "RECORDING",
"description": ""
},
{
"value": "CHAT_COMMAND",
"name": "CHAT_COMMAND",
"description": ""
}
]
},
"direction": {
"type": "string",
"enum": [
"IN",
"OUT"
],
"x-apidog-enum": [
{
"value": "IN",
"name": "IN",
"description": ""
},
{
"value": "OUT",
"name": "OUT",
"description": ""
}
]
},
"author": {
"type": "string",
"enum": [
"CUSTOMER",
"AGENT",
"AGENT_PLATFORM",
"AI",
"BUSINESS",
"SYSTEM"
],
"x-apidog-enum": [
{
"value": "CUSTOMER",
"name": "CUSTOMER",
"description": ""
},
{
"value": "AGENT",
"name": "AGENT",
"description": ""
},
{
"value": "AGENT_PLATFORM",
"name": "AGENT_PLATFORM",
"description": ""
},
{
"value": "AI",
"name": "AI",
"description": ""
},
{
"value": "BUSINESS",
"name": "BUSINESS",
"description": ""
},
{
"value": "SYSTEM",
"name": "SYSTEM",
"description": ""
}
]
},
"content": {
"anyOf": [
{
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"x-apidog-orders": [
"text"
],
"required": [
"text"
],
"description": "Text object",
"x-apidog-ignore-properties": []
},
{
"type": "object",
"properties": {
"media": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"fileKey": {
"type": "string"
},
"caption": {
"type": "string"
},
"name": {
"type": "string"
},
"original_name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"audio",
"image",
"video",
"document"
],
"x-apidog-enum": [
{
"value": "audio",
"name": "audio",
"description": ""
},
{
"value": "image",
"name": "image",
"description": ""
},
{
"value": "video",
"name": "video",
"description": ""
},
{
"value": "document",
"name": "document",
"description": ""
}
]
},
"extension": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"transcription": {
"type": "string"
}
},
"x-apidog-orders": [
"url",
"fileKey",
"caption",
"name",
"original_name",
"type",
"extension",
"mimeType",
"transcription"
],
"required": [
"name",
"type",
"extension",
"mimeType",
"fileKey",
"original_name"
],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"media"
],
"required": [
"media"
],
"description": "Media object",
"x-apidog-ignore-properties": []
}
]
},
"pauseSession": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"PENDING",
"SENT",
"DELIVERED",
"READ",
"FAILED"
],
"x-apidog-enum": [
{
"value": "PENDING",
"name": "PENDING",
"description": ""
},
{
"value": "SENT",
"name": "SENT",
"description": ""
},
{
"value": "DELIVERED",
"name": "DELIVERED",
"description": ""
},
{
"value": "READ",
"name": "READ",
"description": ""
},
{
"value": "FAILED",
"name": "FAILED",
"description": ""
}
]
},
"externalId": {
"type": "string"
},
"sendExternalMessage": {
"type": "boolean",
"description": "If true, it will send a message to the client. If false, it will only record the message in the database."
},
"customerId": {
"type": "string"
},
"departmentId": {
"type": "string"
},
"quotedMessageId": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"sessionId",
"type",
"direction",
"author",
"content",
"pauseSession",
"status",
"externalId",
"sendExternalMessage",
"customerId",
"departmentId",
"quotedMessageId",
"metadata"
],
"required": [
"sessionId",
"type",
"direction",
"author",
"content"
],
"x-apidog-ignore-properties": []
},
"example": {
"sessionId": "uuid",
"type": "MEDIA",
"direction": "OUT",
"author": "AI",
"content": {
"media": {
"url": "https://determined-slipper.com/",
"name": "Freddie Pouros",
"size": "amet culpa veniam",
"type": "video",
"extension": "ad cupidatat elit",
"mime_type": "image/jpeg",
"transcription": "ad"
}
},
"pauseSession": true,
"status": "SENT",
"externalId": "6",
"sendExternalMessage": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20345963-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/messages" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "uuid",
"type": "MEDIA",
"direction": "OUT",
"author": "AI",
"content": {
"media": {
"url": "https://determined-slipper.com/",
"name": "Freddie Pouros",
"size": "amet culpa veniam",
"type": "video",
"extension": "ad cupidatat elit",
"mime_type": "image/jpeg",
"transcription": "ad"
}
},
"pauseSession": true,
"status": "SENT",
"externalId": "6",
"sendExternalMessage": true
}'200
{}Communication/Chat/Messaging/Quick Message
List
gethttps://api.falecomigo.ai/quick-messages
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Messaging/Quick Message"
],
"parameters": [],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Messaging/Quick Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17059923-run"
}Respostas
401curl -X GET "https://api.falecomigo.ai/quick-messages" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
Communication/Chat/Messaging/Quick Message
Create
posthttps://api.falecomigo.ai/quick-messages
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Messaging/Quick Message"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
},
"example": {
"name": "",
"color": "",
"type": "",
"content": {}
}
}
}
},
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Messaging/Quick Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17059942-run"
}Respostas
401curl -X POST "https://api.falecomigo.ai/quick-messages" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"color": "",
"type": "",
"content": {}
}'Communication/Chat/Messaging/Quick Message
Show
gethttps://api.falecomigo.ai/quick-messages/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Messaging/Quick Message"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Messaging/Quick Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17059949-run"
}Respostas
401curl -X GET "https://api.falecomigo.ai/quick-messages/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Communication/Chat/Messaging/Quick Message
Update
puthttps://api.falecomigo.ai/quick-messages/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Messaging/Quick Message"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
},
"example": {
"name": "",
"color": "",
"type": "",
"content": {}
}
}
}
},
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Messaging/Quick Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17059957-run"
}Respostas
401curl -X PUT "https://api.falecomigo.ai/quick-messages/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"color": "",
"type": "",
"content": {}
}'Communication/Chat/Messaging/Quick Message
Delete
deletehttps://api.falecomigo.ai/quick-messages/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Messaging/Quick Message"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Messaging/Quick Message",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17059958-run"
}Respostas
401curl -X DELETE "https://api.falecomigo.ai/quick-messages/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Communication/Chat/Session
List Contacts
gethttps://api.falecomigo.ai/api/sessions/contacts
Parâmetros de consulta
pagestringlimitstringsearchstringintegrationStatusstringstartedBystringintegrationIdstringdepartmentIdstringattendantIdstringtagIdstringfromstringtostringorganizationIdstringstatusstringresponseFilter"all" | "responded" | "not_responded"Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List Contacts",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "integrationStatus",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "startedBy",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "departmentId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "attendantId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "tagId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "from",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organizationId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "responseFilter",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string",
"enum": [
"all",
"responded",
"not_responded"
],
"x-apidog-enum": [
{
"value": "all",
"name": "",
"description": ""
},
{
"value": "responded",
"name": "",
"description": ""
},
{
"value": "not_responded",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20990328-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions/contacts" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Chat/Session
List By Contacts
gethttps://api.falecomigo.ai/api/sessions/by-contact/{contactId}
Parâmetros de caminho
contactIdstringobrigatórioParâmetros de consulta
pagestringlimitstringstatus"OPEN" | "CLOSED" | "ON_HOLD" | "PAUSED" | "QUEUED"fromstringtostringintegrationIdstringorganizationIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List By Contacts",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": false,
"example": "1",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string",
"enum": [
"OPEN",
"CLOSED",
"ON_HOLD",
"PAUSED",
"QUEUED"
],
"x-apidog-enum": [
{
"value": "OPEN",
"name": "",
"description": ""
},
{
"value": "CLOSED",
"name": "",
"description": ""
},
{
"value": "ON_HOLD",
"name": "",
"description": ""
},
{
"value": "PAUSED",
"name": "",
"description": ""
},
{
"value": "QUEUED",
"name": "",
"description": ""
}
]
}
},
{
"name": "from",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string"
}
},
{
"name": "to",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "integrationId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "organizationId",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20990205-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions/by-contact/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Chat/Session
Status
gethttps://api.falecomigo.ai/api/sessions/status
Parâmetros de consulta
businessPhonestringobrigatóriocontactPhonestringobrigatóriostatusstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Status",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [
{
"name": "businessPhone",
"in": "query",
"description": "",
"required": true,
"example": "5511930033032",
"schema": {
"type": "string"
}
},
{
"name": "contactPhone",
"in": "query",
"description": "",
"required": true,
"example": "5511999875251",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "",
"required": true,
"example": "OPEN",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hasSession": {
"type": "boolean"
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contactId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"status": {
"type": "string"
},
"startedBy": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"contactId",
"integrationId",
"organizationId",
"status",
"startedBy",
"createdAt",
"updatedAt"
]
}
}
},
"required": [
"hasSession",
"sessions"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"hasSession",
"sessions"
]
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17889676-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions/status?businessPhone=...&contactPhone=...&status=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{
"hasSession": true,
"sessions": [
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}Communication/Chat/Session
List
gethttps://api.falecomigo.ai/api/sessions
Parâmetros de consulta
integrationIdstringpagestringobrigatóriodistinctByContactstringobrigatóriolimitstringobrigatóriosearchstringstatusstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [
{
"name": "integrationId",
"in": "query",
"description": "",
"required": false,
"example": "193b724f-4cb7-48cf-8bfc-593b2f438985",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": true,
"example": "1",
"schema": {
"type": "string"
}
},
{
"name": "distinctByContact",
"in": "query",
"description": "",
"required": true,
"example": "true",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"required": true,
"example": "50",
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"example": "5511995440247",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"description": "",
"required": false,
"example": "OPEN",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494542-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions?page=...&distinctByContact=...&limit=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Chat/Session
Create
posthttps://api.falecomigo.ai/api/sessions
Corpo
contactIdstringobrigatóriointegrationIdstringobrigatórioorganizationIdstringobrigatóriostatus"OPEN" | "PAUSED" | "CLOSED"startedBy"CUSTOMER" | "AGENT" | "BUSINESS"Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"OPEN",
"PAUSED",
"CLOSED"
],
"x-apidog-enum": [
{
"value": "OPEN",
"name": "OPEN",
"description": ""
},
{
"value": "PAUSED",
"name": "PAUSED",
"description": ""
},
{
"value": "CLOSED",
"name": "CLOSED",
"description": ""
}
]
},
"startedBy": {
"type": "string",
"enum": [
"CUSTOMER",
"AGENT",
"BUSINESS"
],
"x-apidog-enum": [
{
"value": "CUSTOMER",
"name": "CUSTOMER",
"description": ""
},
{
"value": "AGENT",
"name": "AGENT",
"description": ""
},
{
"value": "BUSINESS",
"name": "BUSINESS",
"description": ""
}
]
}
},
"x-apidog-orders": [
"contactId",
"integrationId",
"organizationId",
"status",
"startedBy"
],
"required": [
"contactId",
"integrationId",
"organizationId"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "developing",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20400174-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/sessions" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "OPEN",
"startedBy": "CUSTOMER"
}'200
{}Communication/Chat/Session
Redirect URL (session balancer)
gethttps://api.falecomigo.ai/api/sessions/redirect-url
Parâmetros de consulta
textstringorganizationIdstringcampaignNamestringutm_sourcestringexternalIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Redirect URL (session balancer)",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [
{
"name": "text",
"in": "query",
"description": "",
"required": false,
"example": "Teste Samu",
"schema": {
"type": "string"
}
},
{
"name": "organizationId",
"in": "query",
"description": "",
"required": false,
"example": "c561b867-41d4-489a-ad19-735730917a43",
"schema": {
"type": "string"
}
},
{
"name": "campaignName",
"in": "query",
"description": "",
"required": false,
"example": "teste",
"schema": {
"type": "string"
}
},
{
"name": "utm_source",
"in": "query",
"description": "",
"required": false,
"example": "campanha_1234",
"schema": {
"type": "string"
}
},
{
"name": "externalId",
"in": "query",
"description": "",
"required": false,
"example": "12314123124124",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"timestamp": {
"type": "string"
},
"path": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"error": {
"type": "string"
},
"statusCode": {
"type": "integer"
}
},
"required": [
"message",
"error",
"statusCode"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"message",
"error",
"statusCode"
]
}
},
"required": [
"statusCode",
"timestamp",
"path",
"error"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"statusCode",
"timestamp",
"path",
"error"
]
}
}
},
"headers": {},
"x-apidog-name": "Unauthorized",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18553348-run"
}Respostas
401curl -X GET "https://api.falecomigo.ai/api/sessions/redirect-url" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
Communication/Chat/Session
Update
puthttps://api.falecomigo.ai/api/sessions/1a645855-1366-4803-90a9-e79c074b4966
Corpo
contactIdstringintegrationIdstringorganizationIdstringstatus"CLOSED" | "PAUSED" | "OPEN" | "QUEUED" | "ON_HOLD"externalIdstringassignedAgentIdstringstatusReason"CLOSED_BY_INACTIVITY" | "CLOSED_BY_AGENT" | "CLOSED_BY_AI" | "CLOSED_BY_WINDOW_TIME"endReasonstringassignedCustomerIdstringassignedDepartmentIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"CLOSED",
"PAUSED",
"OPEN",
"QUEUED",
"ON_HOLD"
],
"x-apidog-enum": [
{
"value": "CLOSED",
"name": "CLOSED",
"description": "Sessão encerrada definitivamente"
},
{
"value": "PAUSED",
"name": "PAUSED",
"description": "Sessão pausada temporariamente (atendimento humano)"
},
{
"value": "OPEN",
"name": "OPEN",
"description": "Sessão aberta e ativa (bot)"
},
{
"value": "QUEUED",
"name": "QUEUED",
"description": "Sessão aguardando atendimento na fila"
},
{
"value": "ON_HOLD",
"name": "ON_HOLD",
"description": "Sessão em espera ou aguardando resposta"
}
]
},
"externalId": {
"type": "string"
},
"assignedAgentId": {
"type": "string"
},
"statusReason": {
"type": "string",
"enum": [
"CLOSED_BY_INACTIVITY",
"CLOSED_BY_AGENT",
"CLOSED_BY_AI",
"CLOSED_BY_WINDOW_TIME"
],
"x-apidog-enum": [
{
"value": "CLOSED_BY_INACTIVITY",
"name": "CLOSED_BY_INACTIVITY",
"description": "Sessão encerrada por inatividade do contato"
},
{
"value": "CLOSED_BY_AGENT",
"name": "CLOSED_BY_AGENT",
"description": "Sessão encerrada manualmente por um agente"
},
{
"value": "CLOSED_BY_AI",
"name": "CLOSED_BY_AI",
"description": "Sessão encerrada automaticamente pela IA"
},
{
"value": "CLOSED_BY_WINDOW_TIME",
"name": "CLOSED_BY_WINDOW_TIME",
"description": "Sessão encerrada por expiração da janela de atendimento"
}
]
},
"endReason": {
"type": "string"
},
"assignedCustomerId": {
"type": "string"
},
"assignedDepartmentId": {
"type": "string"
}
},
"x-apidog-orders": [
"contactId",
"integrationId",
"organizationId",
"status",
"externalId",
"assignedAgentId",
"statusReason",
"endReason",
"assignedCustomerId",
"assignedDepartmentId"
],
"x-apidog-ignore-properties": []
},
"example": {
"contactId": "97",
"integrationId": "65",
"organizationId": "98",
"status": "CLOSED",
"externalId": "40",
"assignedAgentId": "9",
"statusReason": "CLOSED_BY_AI",
"endReason": "quis do pariatur cupidatat in",
"assignedCustomerId": "52",
"assignedDepartmentId": "69"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contactId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"status": {
"type": "string"
},
"startedBy": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"contact": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "null"
},
"phoneNumber": {
"type": "string"
},
"externalId": {
"type": "null"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"organizationId",
"name",
"email",
"phoneNumber",
"externalId",
"createdAt",
"updatedAt"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"organizationId",
"name",
"email",
"phoneNumber",
"externalId",
"createdAt",
"updatedAt"
]
},
"integration": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"customerId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"providerId": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"jid": {
"type": "string"
},
"name": {
"type": "string"
},
"qrcode": {
"type": "string"
},
"connected": {
"type": "boolean"
},
"instanceId": {
"type": "string"
},
"integration": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"instanceToken": {
"type": "string"
},
"lastQrCodeUpdate": {
"type": "string"
}
},
"required": [
"jid",
"name",
"qrcode",
"connected",
"instanceId",
"integration",
"phoneNumber",
"phone_number",
"instanceToken",
"lastQrCodeUpdate"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"jid",
"name",
"qrcode",
"connected",
"instanceId",
"integration",
"phoneNumber",
"phone_number",
"instanceToken",
"lastQrCodeUpdate"
]
},
"isActive": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"customerId",
"organizationId",
"providerId",
"settings",
"isActive",
"createdAt",
"updatedAt"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"name",
"customerId",
"organizationId",
"providerId",
"settings",
"isActive",
"createdAt",
"updatedAt"
]
},
"organization": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ownerId": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"shortIdentifier": {
"type": "string"
},
"billingType": {
"type": "string"
},
"parentId": {
"type": "null"
},
"walletId": {
"type": "null"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"ownerId",
"name",
"description",
"shortIdentifier",
"billingType",
"parentId",
"walletId",
"createdAt",
"updatedAt"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"ownerId",
"name",
"description",
"shortIdentifier",
"billingType",
"parentId",
"walletId",
"createdAt",
"updatedAt"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"externalId": {
"type": "string"
},
"externalReferenceId": {
"type": "null"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"direction": {
"type": "string"
},
"author": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"text"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"sessionId",
"externalId",
"externalReferenceId",
"status",
"type",
"direction",
"author",
"content",
"createdAt",
"updatedAt"
]
}
},
"tabulations": {
"type": "array",
"items": {
"type": "string"
}
},
"ticket": {
"type": "null"
}
},
"required": [
"id",
"contactId",
"integrationId",
"organizationId",
"status",
"startedBy",
"createdAt",
"updatedAt",
"contact",
"integration",
"organization",
"messages",
"tabulations",
"ticket"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"contactId",
"integrationId",
"organizationId",
"status",
"startedBy",
"createdAt",
"updatedAt",
"contact",
"integration",
"organization",
"messages",
"tabulations",
"ticket"
]
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17752085-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/sessions/1a645855-1366-4803-90a9-e79c074b4966" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "97",
"integrationId": "65",
"organizationId": "98",
"status": "CLOSED",
"externalId": "40",
"assignedAgentId": "9",
"statusReason": "CLOSED_BY_AI",
"endReason": "quis do pariatur cupidatat in",
"assignedCustomerId": "52",
"assignedDepartmentId": "69"
}'200
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"contact": {
"id": "string",
"organizationId": "string",
"name": "string",
"email": "string",
"phoneNumber": "string",
"externalId": "string",
"createdAt": "string",
"updatedAt": "string"
},
"integration": {
"id": "string",
"name": "string",
"customerId": "string",
"organizationId": "string",
"providerId": "string",
"settings": {
"jid": "string",
"name": "string",
"qrcode": "string",
"connected": true,
"instanceId": "string",
"integration": "string",
"phoneNumber": "string",
"phone_number": "string",
"instanceToken": "string",
"lastQrCodeUpdate": "string"
},
"isActive": true,
"createdAt": "string",
"updatedAt": "string"
},
"organization": {
"id": "string",
"ownerId": "string",
"name": "string",
"description": "string",
"shortIdentifier": "string",
"billingType": "string",
"parentId": "string",
"walletId": "string",
"createdAt": "string",
"updatedAt": "string"
},
"messages": [
{
"id": "string",
"sessionId": "string",
"externalId": "string",
"externalReferenceId": "string",
"status": "string",
"type": "string",
"direction": "string",
"author": "string",
"content": {
"text": null
},
"createdAt": "string",
"updatedAt": "string"
}
],
"tabulations": [
"string"
],
"ticket": "string"
}Communication/Chat/Session
Integration with less sessions
gethttps://api.falecomigo.ai/api/sessions/integration-with-less-sessions
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Integration with less sessions",
"deprecated": false,
"description": "",
"tags": [
"Communication/Chat/Session"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hasSession": {
"type": "boolean"
},
"sessions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contactId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"status": {
"type": "string"
},
"startedBy": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"contactId",
"integrationId",
"organizationId",
"status",
"startedBy",
"createdAt",
"updatedAt"
]
}
}
},
"required": [
"hasSession",
"sessions"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"hasSession",
"sessions"
]
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Chat/Session",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20992284-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions/integration-with-less-sessions" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{
"hasSession": true,
"sessions": [
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}Communication/Department
List
gethttps://api.falecomigo.ai/api/departments
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301599-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/departments" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Department
Create
posthttps://api.falecomigo.ai/api/departments
Corpo
namestringobrigatórioslugstringobrigatóriodescriptionstringtypestringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
}
},
"x-apidog-orders": [
"name",
"slug",
"description",
"type"
],
"required": [
"name",
"slug"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301625-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/departments" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"slug": "string",
"description": "string",
"type": "string"
}'200
{}Communication/Department
Update
puthttps://api.falecomigo.ai/api/departments
Corpo
namestringslugstringdescriptionstringtypestringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
}
},
"x-apidog-orders": [
"name",
"slug",
"description",
"type"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301627-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/departments" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"slug": "string",
"description": "string",
"type": "string"
}'200
{}Communication/Department
Show
gethttps://api.falecomigo.ai/api/departments/{departmendId}
Parâmetros de caminho
departmendIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "departmendId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301663-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/departments/{departmendId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
Delete
deletehttps://api.falecomigo.ai/api/departments/{departmendId}
Parâmetros de caminho
departmendIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "departmendId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301628-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/departments/{departmendId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
List Integration Departments
gethttps://api.falecomigo.ai/api/departments/integrations/{integrationId}
Parâmetros de caminho
integrationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List Integration Departments",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "integrationId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301660-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/departments/integrations/{integrationId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
List Customer Departments
gethttps://api.falecomigo.ai/api/departments/customers/{customerId}
Parâmetros de caminho
customerIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List Customer Departments",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301662-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/departments/customers/{customerId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
Customer Assign
posthttps://api.falecomigo.ai/api/departments/customers/assign
Corpo
departmendIdstringobrigatóriocustomerIdstringobrigatórioisDefaultbooleanAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Customer Assign",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"departmendId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"x-apidog-orders": [
"departmendId",
"customerId",
"isDefault"
],
"required": [
"departmendId",
"customerId"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301629-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/departments/customers/assign" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"departmendId": "string",
"customerId": "string",
"isDefault": true
}'200
{}Communication/Department
Integration Assign
posthttps://api.falecomigo.ai/api/departments/integrations/assign
Corpo
departmendIdstringobrigatóriointegrationIdstringobrigatórioisDefaultbooleanAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Integration Assign",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"departmendId": {
"type": "string"
},
"integrationId": {
"type": "string"
},
"isDefault": {
"type": "boolean"
}
},
"x-apidog-orders": [
"departmendId",
"integrationId",
"isDefault"
],
"required": [
"departmendId",
"integrationId"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301653-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/departments/integrations/assign" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"departmendId": "string",
"integrationId": "string",
"isDefault": true
}'200
{}Communication/Department
Define Default Integration
puthttps://api.falecomigo.ai/api/departments/integrations/{integrationId}/default/{departmentId}
Parâmetros de caminho
integrationIdstringobrigatóriodepartmentIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Define Default Integration",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "integrationId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "departmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301656-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/departments/integrations/{integrationId}/default/{departmentId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
Define Default Customer
puthttps://api.falecomigo.ai/api/departments/customers/{customerId}/default/{departmentId}
Parâmetros de caminho
customerIdstringobrigatóriodepartmentIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Define Default Customer",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "departmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301659-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/departments/customers/{customerId}/default/{departmentId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Department
Customer Unassign
deletehttps://api.falecomigo.ai/api/departments/customers/{departmentId}/{customerId}
Parâmetros de caminho
departmentIdstringobrigatóriocustomerIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Customer Unassign",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "departmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301650-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/departments/customers/{departmentId}/{customerId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'200
{}Communication/Department
Integration Unassign
deletehttps://api.falecomigo.ai/api/departments/integrations/{departmentId}/{integrationId}
Parâmetros de caminho
departmentIdstringobrigatóriointegrationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Integration Unassign",
"deprecated": false,
"description": "",
"tags": [
"Communication/Department"
],
"parameters": [
{
"name": "departmentId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "integrationId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Department",
"x-apidog-status": "testing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20301655-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/departments/integrations/{departmentId}/{integrationId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'200
{}Communication/Dispatch/v2
Create Dispatch
posthttps://api.falecomigo.ai/api/v2/message-dispatch/create
Cabeçalhos
AuthorizationstringobrigatórioCorpo
contactsobject[]obrigatóriocampaignOriginstringobrigatóriocampaignNamestringobrigatóriotemplateIdstringobrigatórioexternalIdstringobrigatóriosheetFileUrlstringobrigatóriocampaignLabelstring[]obrigatórioscheduledAtstringobrigatórioattachmentobjectobrigatóriosettingsobjectobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Dispatch",
"deprecated": false,
"description": "",
"tags": [
"Communication/Dispatch/v2"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"shooter": {
"type": "string"
},
"recipient": {
"type": "string"
},
"variables": {
"type": "object",
"properties": {
"1": {
"type": "string"
}
},
"required": [
"1"
],
"x-apidog-orders": [
"1"
],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"shooter",
"recipient",
"variables"
],
"x-apidog-ignore-properties": []
}
},
"campaignOrigin": {
"type": "string"
},
"campaignName": {
"type": "string"
},
"templateId": {
"type": "string"
},
"externalId": {
"type": "string"
},
"sheetFileUrl": {
"type": "string"
},
"campaignLabel": {
"type": "array",
"items": {
"type": "string"
}
},
"scheduledAt": {
"type": "string"
},
"attachment": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key",
"name"
],
"x-apidog-orders": [
"key",
"name"
],
"x-apidog-ignore-properties": []
},
"settings": {
"type": "object",
"properties": {
"smartBalancing": {
"type": "boolean"
},
"smartReminder": {
"type": "boolean"
},
"pausedSession": {
"type": "boolean"
},
"contactsLabel": {
"type": "string"
}
},
"required": [
"smartBalancing",
"smartReminder",
"pausedSession",
"contactsLabel"
],
"x-apidog-orders": [
"smartBalancing",
"smartReminder",
"pausedSession",
"contactsLabel"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"contacts",
"campaignOrigin",
"campaignName",
"templateId",
"externalId",
"sheetFileUrl",
"campaignLabel",
"scheduledAt",
"attachment",
"settings"
],
"x-apidog-orders": [
"contacts",
"campaignOrigin",
"campaignName",
"templateId",
"externalId",
"sheetFileUrl",
"campaignLabel",
"scheduledAt",
"attachment",
"settings"
],
"x-apidog-ignore-properties": []
},
"examples": {
"1": {
"value": {
"messages": [
{
"shooter": "79fdd7c3-a768-41df-85f8-9e2164c0f14e",
"recipient": "551151019988",
"customer_name": "João",
"customer_age": "37"
},
{
"shooter": "79fdd7c3-a768-41df-85f8-9e2164c0f14e",
"recipient": "551151234567",
"customer_name": "Tadeu",
"customer_age": "29"
}
],
"templateId": "56dda5ae-132c-4eec-9dc3-5be87e9dffdc",
"name": "Campaign with template"
},
"summary": "Shooting with templates",
"description": "Template example:\nHello {{ customer_name }} you are {{ customer_age }} years old.\n\nIn this case, João will receive from the integration 79fdd7c3-a768-41df-85f8-9e2164c0f14e the text:\nHello João you are 37 years old.\n\nAnd Tadeu will receive from the integration 79fdd7c3-a768-41df-85f8-9e2164c0f14e the text:\nHello Tadeu you are 29 years old."
},
"2": {
"value": {
"messages": [
{
"shooter": "79fdd7c3-a768-41df-85f8-9e2164c0f14e",
"recipient": "551151019988",
"message": "Hi there! Welcome to falecomigo.ai. We are excited to have you here."
}
],
"templateId": "56dda5ae-132c-4eec-9dc3-5be87e9dffdc",
"name": "Isolated shooting"
},
"summary": "Single shot shooting"
},
"3": {
"value": {
"messages": [
{
"recipient": "551151019988",
"customer_name": "João",
"customer_age": "37"
},
{
"recipient": "551151234567",
"customer_name": "Tadeu",
"customer_age": "29"
}
],
"templateId": "56dda5ae-132c-4eec-9dc3-5be87e9dffdc",
"name": "Campaign with template",
"isSessionBalanced": true
},
"summary": "Balanced shooting",
"description": "Different from Shooting with template example, this one is a balanced shooting. As you can see, we do not declare the \"shooter\", because the system will automatically defines it."
},
"4": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 4"
},
"5": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 5"
},
"6": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 6"
},
"7": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 7"
},
"8": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 8"
},
"9": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 9"
},
"10": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 10"
},
"11": {
"value": {
"contacts": [
{
"shooter": "5511965237184",
"recipient": "5534991189081",
"variables": {
"1": "Sam"
}
},
{
"shooter": "5511965237184",
"recipient": "5511969298730",
"variables": {
"1": "Paulinho"
}
}
],
"campaignOrigin": "BASE_CONTACT",
"campaignName": "Campanha de teste",
"templateId": "e0124dc0-b979-4e1c-a382-7c8138b7ee8b",
"externalId": null,
"sheetFileUrl": null,
"campaignLabel": null,
"scheduledAt": null,
"attachment": null,
"settings": {
"smartBalancing": false,
"smartReminder": false,
"pausedSession": false,
"contactsLabel": null
}
},
"summary": "Example 11"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Dispatch/v2",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23710526-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/v2/message-dispatch/create" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"messages": [
{
"shooter": "79fdd7c3-a768-41df-85f8-9e2164c0f14e",
"recipient": "551151019988",
"customer_name": "João",
"customer_age": "37"
},
{
"shooter": "79fdd7c3-a768-41df-85f8-9e2164c0f14e",
"recipient": "551151234567",
"customer_name": "Tadeu",
"customer_age": "29"
}
],
"templateId": "56dda5ae-132c-4eec-9dc3-5be87e9dffdc",
"name": "Campaign with template"
}'200
{}Communication/Template
List
gethttps://api.falecomigo.ai/api/templates
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494556-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/templates" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Template
Create
posthttps://api.falecomigo.ai/api/templates
Corpo
namestringobrigatóriodescriptionstringobrigatóriocontentstringobrigatóriocategorystringobrigatóriotype"CUSTOM" | "META" | "EMAIL"obrigatóriovariantstringobrigatórioisControlbooleanobrigatóriotagsstring[]obrigatóriolanguagestringobrigatóriointegrationIdsstring[]obrigatóriocomponentsobject[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"content": {
"type": "string"
},
"category": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"CUSTOM",
"META",
"EMAIL"
],
"x-apidog-enum": [
{
"value": "CUSTOM",
"name": "CUSTOM",
"description": ""
},
{
"value": "META",
"name": "META",
"description": ""
},
{
"value": "EMAIL",
"name": "EMAIL",
"description": ""
}
]
},
"variant": {
"type": "string"
},
"isControl": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": "string"
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
}
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"format": {
"type": "string"
},
"text": {
"type": "string"
},
"example": {
"type": "object",
"properties": {
"body_text": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"body_text"
],
"x-apidog-orders": [
"body_text"
],
"x-apidog-ignore-properties": []
},
"buttons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"URL",
"PHONE_NUMBER",
"QUICK_REPLY"
]
},
"text": {
"type": "string"
},
"url": {
"type": "string",
"description": "URL com {{1}} para variável dinâmica"
},
"phone_number": {
"type": "string"
},
"example": {
"type": "array",
"items": {
"type": "string"
},
"description": "Valor de exemplo para a variável dinâmica da URL"
}
},
"required": [
"type",
"text"
],
"x-apidog-orders": [
"type",
"text",
"url",
"phone_number",
"example"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"type"
],
"x-apidog-orders": [
"type",
"format",
"text",
"example",
"buttons"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"name",
"description",
"content",
"category",
"variant",
"isControl",
"tags",
"language",
"integrationIds",
"components",
"type"
],
"x-apidog-orders": [
"name",
"description",
"content",
"category",
"type",
"variant",
"isControl",
"tags",
"language",
"integrationIds",
"components"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494558-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/templates" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}'200
{}Communication/Template
Sync All Meta Integrations
posthttps://api.falecomigo.ai/api/templates/meta/sync-all
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Sync All Meta Integrations",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-27708222-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/templates/meta/sync-all" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Communication/Template
Sync Single Meta Integrations
posthttps://api.falecomigo.ai/api/templates/meta/sync/{integrationId}
Parâmetros de caminho
integrationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Sync Single Meta Integrations",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [
{
"name": "integrationId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-27708633-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/templates/meta/sync/{integrationId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Template
Create Meta
posthttps://api.falecomigo.ai/api/templates/meta
Corpo
namestringobrigatóriolanguagestringobrigatóriocategorystringobrigatóriointegrationIdsstring[]obrigatóriocomponentsobject[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Meta",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"language": {
"type": "string"
},
"category": {
"type": "string"
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
}
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"format": {
"type": "string"
},
"example": {
"type": "object",
"properties": {
"body_text": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"body_text"
],
"x-apidog-orders": [
"body_text"
],
"x-apidog-ignore-properties": []
},
"buttons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"text": {
"type": "string"
},
"type": {
"type": "string"
},
"example": {
"type": "array",
"items": {
"type": "string"
}
}
},
"x-apidog-orders": [
"url",
"text",
"type",
"example"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"text",
"type"
],
"x-apidog-orders": [
"text",
"type",
"format",
"example",
"buttons"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"name",
"language",
"category",
"integrationIds",
"components"
],
"x-apidog-orders": [
"name",
"language",
"category",
"integrationIds",
"components"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-27896600-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/templates/meta" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}'200
{}Communication/Template
Show
gethttps://api.falecomigo.ai/api/templates/{templateId}
Parâmetros de caminho
templateIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494557-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/templates/{templateId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Communication/Template
Update
puthttps://api.falecomigo.ai/api/templates/{templateId}
Parâmetros de caminho
templateIdstringobrigatórioCorpo
namestringdescriptionstringcontentstringcategorystringtype"CUSTOM" | "META" | "EMAIL"variantstringisControlbooleantagsstring[]languagestringintegrationIdsstring[]componentsobject[]Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Communication/Template"
],
"parameters": [
{
"name": "templateId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"content": {
"type": "string"
},
"category": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"CUSTOM",
"META",
"EMAIL"
],
"x-apidog-enum": [
{
"value": "CUSTOM",
"name": "CUSTOM",
"description": ""
},
{
"value": "META",
"name": "META",
"description": ""
},
{
"value": "EMAIL",
"name": "EMAIL",
"description": ""
}
]
},
"variant": {
"type": "string"
},
"isControl": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"language": {
"type": "string"
},
"integrationIds": {
"type": "array",
"items": {
"type": "string"
}
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"format": {
"type": "string"
},
"text": {
"type": "string"
},
"example": {
"type": "object",
"properties": {
"body_text": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"body_text"
],
"x-apidog-orders": [
"body_text"
],
"x-apidog-ignore-properties": []
},
"buttons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"URL",
"PHONE_NUMBER",
"QUICK_REPLY"
]
},
"text": {
"type": "string"
},
"url": {
"type": "string",
"description": "URL com {{1}} para variável dinâmica"
},
"phone_number": {
"type": "string"
},
"example": {
"type": "array",
"items": {
"type": "string"
},
"description": "Valor de exemplo para a variável dinâmica da URL"
}
},
"required": [
"type",
"text"
],
"x-apidog-orders": [
"type",
"text",
"url",
"phone_number",
"example"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"type"
],
"x-apidog-orders": [
"type",
"format",
"text",
"example",
"buttons"
],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-orders": [
"name",
"description",
"content",
"category",
"type",
"variant",
"isControl",
"tags",
"language",
"integrationIds",
"components"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "tabulação teste 2",
"description": "Descrição2222 detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false,
"integration_ids": [],
"tabulation_settings": [
{
"tabulationId": "",
"name": "",
"type": "",
"settings": {}
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Communication/Template",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494559-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/templates/{templateId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "tabulação teste 2",
"description": "Descrição2222 detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false,
"integration_ids": [],
"tabulation_settings": [
{
"tabulationId": "",
"name": "",
"type": "",
"settings": {}
}
]
}'200
{}Crm
List
gethttps://api.falecomigo.ai/api/contacts
Parâmetros de consulta
integrationIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [
{
"name": "integrationId",
"in": "query",
"description": "",
"required": false,
"example": "2086b7df-10e1-4e8b-afe9-4cbd9f251899",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18185103-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contacts" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm
Create Contact
posthttps://api.falecomigo.ai/api/contacts
Corpo
namestringname
emailstringphoneNumberstringexternalIdstringbypassBotsbooleanorigin"WHATSAPP_BUSINESS" | "WHATSAPP_META" | "TELEGRAM" | "INSTAGRAM" | "TELEPHONE" | "EMAIL" | "API" | "LEAD" | "META_LEAD" | "WEB_CHAT" | "WEB_FORM" | "LANDING_PAGE" | "FACEBOOK" | "MESSENGER" | "SMS" | "TIKTOK" | "LINKEDIN" | "X_TWITTER" | "THREADS" | "ECOMMERCE" | "SUPPORT_TICKET" | "HELP_DESK" | "CHATBOT_FALLBACK" | "N8N" | "INTEGRATION_WEBHOOK" | "IN_PERSON" | "EVENT" | "REFERRAL" | "MANUAL_ENTRY"Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name"
},
"email": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"externalId": {
"type": "string"
},
"bypassBots": {
"type": "boolean"
},
"origin": {
"type": "string",
"enum": [
"WHATSAPP_BUSINESS",
"WHATSAPP_META",
"TELEGRAM",
"INSTAGRAM",
"TELEPHONE",
"EMAIL",
"API",
"LEAD",
"META_LEAD",
"WEB_CHAT",
"WEB_FORM",
"LANDING_PAGE",
"FACEBOOK",
"MESSENGER",
"SMS",
"TIKTOK",
"LINKEDIN",
"X_TWITTER",
"THREADS",
"ECOMMERCE",
"SUPPORT_TICKET",
"HELP_DESK",
"CHATBOT_FALLBACK",
"N8N",
"INTEGRATION_WEBHOOK",
"IN_PERSON",
"EVENT",
"REFERRAL",
"MANUAL_ENTRY"
],
"x-apidog-enum": [
{
"value": "WHATSAPP_BUSINESS",
"name": "WhatsApp Business",
"description": ""
},
{
"value": "WHATSAPP_META",
"name": "WhatsApp Meta",
"description": ""
},
{
"value": "TELEGRAM",
"name": "Telegram",
"description": ""
},
{
"value": "INSTAGRAM",
"name": "Instagram",
"description": ""
},
{
"value": "TELEPHONE",
"name": "Telefone",
"description": ""
},
{
"value": "EMAIL",
"name": "E-mail",
"description": ""
},
{
"value": "API",
"name": "API",
"description": ""
},
{
"value": "LEAD",
"name": "Lead",
"description": ""
},
{
"value": "META_LEAD",
"name": "Lead (Meta)",
"description": ""
},
{
"value": "WEB_CHAT",
"name": "Chat Web",
"description": ""
},
{
"value": "WEB_FORM",
"name": "Formulário Web",
"description": ""
},
{
"value": "LANDING_PAGE",
"name": "Landing Page",
"description": ""
},
{
"value": "FACEBOOK",
"name": "Facebook",
"description": ""
},
{
"value": "MESSENGER",
"name": "Messenger",
"description": ""
},
{
"value": "SMS",
"name": "SMS",
"description": ""
},
{
"value": "TIKTOK",
"name": "TikTok",
"description": ""
},
{
"value": "LINKEDIN",
"name": "LinkedIn",
"description": ""
},
{
"value": "X_TWITTER",
"name": "Twitter (X)",
"description": ""
},
{
"value": "THREADS",
"name": "Threads",
"description": ""
},
{
"value": "ECOMMERCE",
"name": "E-commerce",
"description": ""
},
{
"value": "SUPPORT_TICKET",
"name": "Ticket de Suporte",
"description": ""
},
{
"value": "HELP_DESK",
"name": "Help Desk",
"description": ""
},
{
"value": "CHATBOT_FALLBACK",
"name": "Fallback do Chatbot",
"description": ""
},
{
"value": "N8N",
"name": "n8n",
"description": ""
},
{
"value": "INTEGRATION_WEBHOOK",
"name": "Webhook de Integração",
"description": ""
},
{
"value": "IN_PERSON",
"name": "Presencial",
"description": ""
},
{
"value": "EVENT",
"name": "Evento",
"description": ""
},
{
"value": "REFERRAL",
"name": "Indicação",
"description": ""
},
{
"value": "MANUAL_ENTRY",
"name": "Entrada Manual",
"description": ""
}
]
}
},
"x-apidog-orders": [
"name",
"email",
"phoneNumber",
"externalId",
"bypassBots",
"origin"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24575655-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/contacts" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"email": "string",
"phoneNumber": "string",
"externalId": "string",
"bypassBots": true,
"origin": "WHATSAPP_BUSINESS"
}'200
{}Crm
Smart Contact
posthttps://api.falecomigo.ai/smart-contact
Cabeçalhos
AuthorizationstringobrigatórioCorpo
qstringobrigatóriolocationstringobrigatórioglstringobrigatóriohlstringobrigatórioresultsintegerobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Smart Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{auth_token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"q": {
"type": "string"
},
"location": {
"type": "string"
},
"gl": {
"type": "string"
},
"hl": {
"type": "string"
},
"results": {
"type": "integer"
}
},
"required": [
"q",
"location",
"gl",
"hl",
"results"
],
"x-apidog-orders": [
"q",
"location",
"gl",
"hl",
"results"
],
"x-apidog-ignore-properties": []
},
"example": {
"q": "clinica-medica em São Paulo - SP - Vila Arriete",
"location": "Brazil",
"gl": "br",
"hl": "pt-br",
"results": 50
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494487-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/smart-contact" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"q": "clinica-medica em São Paulo - SP - Vila Arriete",
"location": "Brazil",
"gl": "br",
"hl": "pt-br",
"results": 50
}'200
{}Crm
Update Contact
puthttps://api.falecomigo.ai/api/contacts/{contactId}
Parâmetros de caminho
contactIdstringobrigatórioCorpo
namestringname
emailstringphoneNumberstringbypassBotsbooleanorigin"WHATSAPP_BUSINESS" | "WHATSAPP_META" | "TELEGRAM" | "INSTAGRAM" | "TELEPHONE" | "EMAIL" | "API" | "LEAD" | "META_LEAD" | "WEB_CHAT" | "WEB_FORM" | "LANDING_PAGE" | "FACEBOOK" | "MESSENGER" | "SMS" | "TIKTOK" | "LINKEDIN" | "X_TWITTER" | "THREADS" | "ECOMMERCE" | "SUPPORT_TICKET" | "HELP_DESK" | "CHATBOT_FALLBACK" | "N8N" | "INTEGRATION_WEBHOOK" | "IN_PERSON" | "EVENT" | "REFERRAL" | "MANUAL_ENTRY"Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name"
},
"email": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"bypassBots": {
"type": "boolean"
},
"origin": {
"type": "string",
"enum": [
"WHATSAPP_BUSINESS",
"WHATSAPP_META",
"TELEGRAM",
"INSTAGRAM",
"TELEPHONE",
"EMAIL",
"API",
"LEAD",
"META_LEAD",
"WEB_CHAT",
"WEB_FORM",
"LANDING_PAGE",
"FACEBOOK",
"MESSENGER",
"SMS",
"TIKTOK",
"LINKEDIN",
"X_TWITTER",
"THREADS",
"ECOMMERCE",
"SUPPORT_TICKET",
"HELP_DESK",
"CHATBOT_FALLBACK",
"N8N",
"INTEGRATION_WEBHOOK",
"IN_PERSON",
"EVENT",
"REFERRAL",
"MANUAL_ENTRY"
],
"x-apidog-enum": [
{
"value": "WHATSAPP_BUSINESS",
"name": "WhatsApp Business",
"description": ""
},
{
"value": "WHATSAPP_META",
"name": "WhatsApp Meta",
"description": ""
},
{
"value": "TELEGRAM",
"name": "Telegram",
"description": ""
},
{
"value": "INSTAGRAM",
"name": "Instagram",
"description": ""
},
{
"value": "TELEPHONE",
"name": "Telefone",
"description": ""
},
{
"value": "EMAIL",
"name": "E-mail",
"description": ""
},
{
"value": "API",
"name": "API",
"description": ""
},
{
"value": "LEAD",
"name": "Lead",
"description": ""
},
{
"value": "META_LEAD",
"name": "Lead (Meta)",
"description": ""
},
{
"value": "WEB_CHAT",
"name": "Chat Web",
"description": ""
},
{
"value": "WEB_FORM",
"name": "Formulário Web",
"description": ""
},
{
"value": "LANDING_PAGE",
"name": "Landing Page",
"description": ""
},
{
"value": "FACEBOOK",
"name": "Facebook",
"description": ""
},
{
"value": "MESSENGER",
"name": "Messenger",
"description": ""
},
{
"value": "SMS",
"name": "SMS",
"description": ""
},
{
"value": "TIKTOK",
"name": "TikTok",
"description": ""
},
{
"value": "LINKEDIN",
"name": "LinkedIn",
"description": ""
},
{
"value": "X_TWITTER",
"name": "Twitter (X)",
"description": ""
},
{
"value": "THREADS",
"name": "Threads",
"description": ""
},
{
"value": "ECOMMERCE",
"name": "E-commerce",
"description": ""
},
{
"value": "SUPPORT_TICKET",
"name": "Ticket de Suporte",
"description": ""
},
{
"value": "HELP_DESK",
"name": "Help Desk",
"description": ""
},
{
"value": "CHATBOT_FALLBACK",
"name": "Fallback do Chatbot",
"description": ""
},
{
"value": "N8N",
"name": "n8n",
"description": ""
},
{
"value": "INTEGRATION_WEBHOOK",
"name": "Webhook de Integração",
"description": ""
},
{
"value": "IN_PERSON",
"name": "Presencial",
"description": ""
},
{
"value": "EVENT",
"name": "Evento",
"description": ""
},
{
"value": "REFERRAL",
"name": "Indicação",
"description": ""
},
{
"value": "MANUAL_ENTRY",
"name": "Entrada Manual",
"description": ""
}
]
}
},
"x-apidog-orders": [
"name",
"email",
"phoneNumber",
"bypassBots",
"origin"
],
"x-apidog-ignore-properties": []
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-20038913-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/contacts/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"email": "string",
"phoneNumber": "string",
"bypassBots": true,
"origin": "WHATSAPP_BUSINESS"
}'200
{}Crm
Get contacts by integration id
gethttps://api.falecomigo.ai/api/contacts/integration/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get contacts by integration id",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19471812-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contacts/integration/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm
Evolution
gethttps://api.falecomigo.ai/api/contacts/evolution
Parâmetros de consulta
integrationIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Evolution",
"deprecated": false,
"description": "",
"tags": [
"Crm"
],
"parameters": [
{
"name": "integrationId",
"in": "query",
"description": "",
"required": false,
"example": "fbbd1724-3b6e-4e8c-b05d-5d7b764cd3bd",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"required": [
"id",
"name",
"phoneNumber"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"id",
"name",
"phoneNumber"
]
}
},
"pagination": {
"type": "object",
"properties": {
"total_data": {
"type": "integer"
},
"total_pages": {
"type": "integer"
},
"current_page": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total_data",
"total_pages",
"current_page",
"limit"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"total_data",
"total_pages",
"current_page",
"limit"
]
}
},
"required": [
"data",
"pagination"
],
"x-apidog-ignore-properties": [],
"x-apidog-orders": [
"data",
"pagination"
]
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm",
"x-apidog-status": "developing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-17810300-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contacts/evolution" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{
"data": [
{
"id": "string",
"name": "string",
"phoneNumber": "string"
}
],
"pagination": {
"total_data": 0,
"total_pages": 0,
"current_page": 0,
"limit": 0
}
}Crm/Attribute
Get all attribute for the active customer organization
gethttps://api.falecomigo.ai/api/attribute
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all attribute for the active customer organization",
"deprecated": false,
"description": "",
"tags": [
"Crm/Attribute"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Attribute",
"x-apidog-status": "developing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19090040-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/attribute" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Attribute
Create an attribute
posthttps://api.falecomigo.ai/api/attribute
Corpo
namestringobrigatóriodescriptionstringobrigatóriotype"TEXT" | "DATE" | "DATETIME" | "INTEGER" | "FLOAT" | "DOCUMENT"obrigatórioorganizationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create an attribute",
"deprecated": false,
"description": "",
"tags": [
"Crm/Attribute"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"TEXT",
"DATE",
"DATETIME",
"INTEGER",
"FLOAT",
"DOCUMENT"
],
"x-apidog-enum": [
{
"value": "TEXT",
"name": "",
"description": ""
},
{
"value": "DATE",
"name": "",
"description": ""
},
{
"value": "DATETIME",
"name": "",
"description": ""
},
{
"value": "INTEGER",
"name": "",
"description": ""
},
{
"value": "FLOAT",
"name": "",
"description": ""
},
{
"value": "DOCUMENT",
"name": "",
"description": ""
}
]
},
"organizationId": {
"type": "string"
}
},
"x-apidog-orders": [
"name",
"description",
"type",
"organizationId"
],
"required": [
"name",
"type",
"organizationId",
"description"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Telefone alternativo",
"description": "Telefone adicional que pode ser usado para entrar em contato com o cliente.",
"type": "TEXT",
"organizationId": "c561b867-41d4-489a-ad19-735730917a43"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Attribute",
"x-apidog-status": "developing",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19007729-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/attribute" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Telefone alternativo",
"description": "Telefone adicional que pode ser usado para entrar em contato com o cliente.",
"type": "TEXT",
"organizationId": "c561b867-41d4-489a-ad19-735730917a43"
}'200
{}Crm/Contact/Attribute
Get all
gethttps://api.falecomigo.ai/api/contact-attribute
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Attribute"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Attribute",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19008444-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contact-attribute" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Contact/Attribute
Create an attribute for a contact
posthttps://api.falecomigo.ai/api/contact-attribute
Corpo
contactIdstringobrigatórioattributeIdstringobrigatóriovaluestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create an attribute for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Attribute"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"attributeId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-apidog-orders": [
"contactId",
"attributeId",
"value"
],
"required": [
"contactId",
"attributeId",
"value"
],
"x-apidog-ignore-properties": []
},
"example": {
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"attributeId": "93b99469-925c-4cc9-8782-7d7c9d409ea0",
"value": "10"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Attribute",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19008460-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/contact-attribute" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"attributeId": "93b99469-925c-4cc9-8782-7d7c9d409ea0",
"value": "10"
}'200
{}Crm/Contact/Attribute
Get all attributes for a contact
gethttps://api.falecomigo.ai/api/contact-attribute/contact/{contactId}
Parâmetros de caminho
contactIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all attributes for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Attribute"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"example": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Attribute",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19008453-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contact-attribute/contact/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Attribute
Update a contact attribute
puthttps://api.falecomigo.ai/api/contact-attribute/{id}
Parâmetros de caminho
idstringobrigatórioCorpo
valuestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update a contact attribute",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Attribute"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"x-apidog-orders": [
"value"
],
"required": [
"value"
],
"x-apidog-ignore-properties": []
},
"example": {
"value": "200"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Attribute",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19008472-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/contact-attribute/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"value": "200"
}'200
{}Crm/Contact/Attribute
Delete a contact attribute
deletehttps://api.falecomigo.ai/api/contact-attribute/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete a contact attribute",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Attribute"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Attribute",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19008478-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/contact-attribute/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Tabulation
Create ContactTabulation
posthttps://api.falecomigo.ai/api/contact-tabulation
Corpo
contactIdstringobrigatóriotabulationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create ContactTabulation",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Tabulation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"tabulationId": {
"type": "string"
}
},
"x-apidog-orders": [
"contactId",
"tabulationId"
],
"required": [
"contactId",
"tabulationId"
],
"x-apidog-ignore-properties": []
},
"example": {
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"tabulationId": "b0d192b1-3822-40e0-9c74-e8cbff4b261d"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Tabulation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18962451-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/contact-tabulation" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"tabulationId": "b0d192b1-3822-40e0-9c74-e8cbff4b261d"
}'200
{}Crm/Contact/Tabulation
Change tabulation for a contact
patchhttps://api.falecomigo.ai/api/contact-tabulation
Corpo
contactIdstringobrigatóriocurrentTabulationIdstringobrigatórionewTabulationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Change tabulation for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Tabulation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"currentTabulationId": {
"type": "string"
},
"newTabulationId": {
"type": "string"
}
},
"x-apidog-orders": [
"contactId",
"currentTabulationId",
"newTabulationId"
],
"required": [
"contactId",
"currentTabulationId",
"newTabulationId"
],
"x-apidog-ignore-properties": []
},
"example": {
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"currentTabulationId": "c92963a5-8f01-4e27-9a60-a3fee7ca1a5c",
"newTabulationId": "e596a4ab-a149-4a95-a07c-9daad0ec0094"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Tabulation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19171405-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/contact-tabulation" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"currentTabulationId": "c92963a5-8f01-4e27-9a60-a3fee7ca1a5c",
"newTabulationId": "e596a4ab-a149-4a95-a07c-9daad0ec0094"
}'200
{}Crm/Contact/Tabulation
Delete ContactTabulation
deletehttps://api.falecomigo.ai/api/contact-tabulation/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete ContactTabulation",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Tabulation"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Tabulation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18963061-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/contact-tabulation/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Tabulation
Get all tabulations for a contact
gethttps://api.falecomigo.ai/api/contact-tabulation/{contactId}
Parâmetros de caminho
contactIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all tabulations for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Tabulation"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"example": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Tabulation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18963220-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contact-tabulation/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Observation
Get all observation for a contact
gethttps://api.falecomigo.ai/api/contact-observation/{contactId}
Parâmetros de caminho
contactIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all observation for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Observation"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"example": "8ff858f6-4423-43cb-b3dc-ed18ca954571",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Observation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18964048-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contact-observation/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Observation
Create observation for a contact
posthttps://api.falecomigo.ai/api/contact-observation
Corpo
textstringobrigatórioisPinnedbooleancontactIdstringobrigatóriocreatedBystringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create observation for a contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Observation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"isPinned": {
"type": "boolean"
},
"contactId": {
"type": "string"
},
"createdBy": {
"type": "string"
}
},
"x-apidog-orders": [
"text",
"isPinned",
"contactId",
"createdBy"
],
"required": [
"text",
"contactId",
"createdBy"
],
"x-apidog-ignore-properties": []
},
"example": {
"text": "Observação bem legal pro paulinho!!",
"isPinned": false,
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"createdBy": "f78819a0-d534-418b-bec2-f282ae49818f"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Observation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18964392-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/contact-observation" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"text": "Observação bem legal pro paulinho!!",
"isPinned": false,
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"createdBy": "f78819a0-d534-418b-bec2-f282ae49818f"
}'200
{}Crm/Contact/Observation
Update an observation
patchhttps://api.falecomigo.ai/api/contact-observation/{id}
Parâmetros de caminho
idstringobrigatórioCorpo
textstringisPinnedbooleanAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update an observation",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Observation"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "3ce1821a-ea1d-428f-966c-12074569a431",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"isPinned": {
"type": "boolean"
}
},
"x-apidog-orders": [
"text",
"isPinned"
],
"x-apidog-ignore-properties": []
},
"example": {
"isPinned": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Observation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18965130-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/contact-observation/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"isPinned": true
}'200
{}Crm/Contact/Observation
Delete an observation
deletehttps://api.falecomigo.ai/api/contact-observation/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete an observation",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Observation"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "3ce1821a-ea1d-428f-966c-12074569a431",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Observation",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18965149-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/contact-observation/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Profile
Get Profile
gethttps://api.falecomigo.ai/api/profile/{customerId}
Parâmetros de caminho
customerIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Profile",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"example": "customer-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494525-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/profile/{customerId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Profile
Update Profile
puthttps://api.falecomigo.ai/api/profile/{customerId}
Parâmetros de caminho
customerIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Profile",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"example": "customer-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": {
"firstName": "Nome Atualizado",
"lastName": "Sobrenome Atualizado",
"phone": "+5511987654321"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494526-run"
}Respostas
200Envie o corpo como
text/plain. Consulte a estrutura completa desta operação e o arquivo OpenAPI para os campos e exemplos.200
{}Crm/Contact/Profile
Upload Profile Picture
posthttps://api.falecomigo.ai/api/profile/{customerId}/profile-picture
Parâmetros de caminho
customerIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioCorpo
filestring · binaryobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Upload Profile Picture",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"example": "customer-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
},
"examples": {}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494527-run"
}Respostas
200Envie o corpo como
multipart/form-data. Consulte a estrutura completa desta operação e o arquivo OpenAPI para os campos e exemplos.200
{}Crm/Contact/Profile
Get Organizations
gethttps://api.falecomigo.ai/api/profile/{customerId}/organizations
Parâmetros de caminho
customerIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Organizations",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "",
"required": true,
"example": "customer-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494528-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/profile/{customerId}/organizations" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Contact/Profile
Update Organization
puthttps://api.falecomigo.ai/api/profile/organizations/{organizationId}
Parâmetros de caminho
organizationIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Organization",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "",
"required": true,
"example": "org-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": {
"name": "Nome Atualizado",
"description": "Descrição atualizada",
"domain": "novodominio.com.br"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494529-run"
}Respostas
200Envie o corpo como
text/plain. Consulte a estrutura completa desta operação e o arquivo OpenAPI para os campos e exemplos.200
{}Crm/Contact/Profile
Update Billing Info
puthttps://api.falecomigo.ai/api/profile/organizations/{organizationId}/billing
Parâmetros de caminho
organizationIdstringobrigatórioCabeçalhos
AuthorizationstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Billing Info",
"deprecated": false,
"description": "",
"tags": [
"Crm/Contact/Profile"
],
"parameters": [
{
"name": "organizationId",
"in": "path",
"description": "",
"required": true,
"example": "org-uuid-aqui",
"schema": {
"type": "string"
}
},
{
"name": "Authorization",
"in": "header",
"description": "",
"required": true,
"example": "Bearer {{token}}",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
},
"example": {
"billingAddress": "Rua Exemplo, 123",
"city": "São Paulo",
"state": "SP",
"zipCode": "01234-567",
"paymentMethod": "creditCard"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Contact/Profile",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494530-run"
}Respostas
200Envie o corpo como
text/plain. Consulte a estrutura completa desta operação e o arquivo OpenAPI para os campos e exemplos.200
{}Crm/Kanban
Get kanban boards
gethttps://api.falecomigo.ai/api/kanban
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get kanban boards",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19160403-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/kanban" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Kanban
Create kanban board
posthttps://api.falecomigo.ai/api/kanban
Corpo
namestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create kanban board",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"x-apidog-orders": [
"name"
],
"required": [
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Lead novo"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19159624-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/kanban" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Lead novo"
}'200
{}Crm/Kanban
Get kanban board columns
gethttps://api.falecomigo.ai/api/kanban/{boardId}
Parâmetros de caminho
boardIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get kanban board columns",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [
{
"name": "boardId",
"in": "path",
"description": "",
"required": true,
"example": "809c3358-2ba7-4d28-ae61-4e7233313aa4",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19160423-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/kanban/{boardId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Kanban
Create kanban board column
posthttps://api.falecomigo.ai/api/kanban/{boardId}
Parâmetros de caminho
boardIdstringobrigatórioCorpo
namestringobrigatóriotabulationIdstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create kanban board column",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [
{
"name": "boardId",
"in": "path",
"description": "",
"required": true,
"example": "809c3358-2ba7-4d28-ae61-4e7233313aa4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tabulationId": {
"type": "string"
}
},
"x-apidog-orders": [
"name",
"tabulationId"
],
"required": [
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Lead novo"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19159747-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/kanban/{boardId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Lead novo"
}'200
{}Crm/Kanban
Change board name
patchhttps://api.falecomigo.ai/api/kanban/{boardId}
Parâmetros de caminho
boardIdstringobrigatórioCorpo
namestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Change board name",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [
{
"name": "boardId",
"in": "path",
"description": "",
"required": true,
"example": "809c3358-2ba7-4d28-ae61-4e7233313aa4",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"x-apidog-orders": [
"name"
],
"required": [
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Novo funil"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19162538-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/kanban/{boardId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Novo funil"
}'200
{}Crm/Kanban
Delete kanban board
deletehttps://api.falecomigo.ai/api/kanban/{boardId}
Parâmetros de caminho
boardIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete kanban board",
"deprecated": false,
"description": "",
"tags": [
"Crm/Kanban"
],
"parameters": [
{
"name": "boardId",
"in": "path",
"description": "",
"required": true,
"example": "5e1d548a-4972-4696-a957-91e6b9e0018f",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Kanban",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19165932-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/kanban/{boardId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
List Leads
gethttps://api.falecomigo.ai/api/leads
Parâmetros de consulta
pagestringobrigatóriolimitstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List Leads",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"required": true,
"example": "1",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"required": true,
"example": "10",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682467-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads?page=...&limit=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Leads
Create Lead
posthttps://api.falecomigo.ai/api/leads
Cabeçalhos
Content-TypestringobrigatórioCorpo
namestringobrigatórioemailstringphonestringobrigatóriocompanystringwebsitestringavatarstringpositionstringsourcestringcontactOriginConfigIdstringstatusstringstatusIdstringscoreintegertemperaturestringestimatedValueintegernotesstringisIcpbooleanownerIdstringmetadataobjectAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"company": {
"type": "string"
},
"website": {
"type": "string"
},
"avatar": {
"type": "string"
},
"position": {
"type": "string"
},
"source": {
"type": "string"
},
"contactOriginConfigId": {
"type": "string"
},
"status": {
"type": "string"
},
"statusId": {
"type": "string"
},
"score": {
"type": "integer"
},
"temperature": {
"type": "string"
},
"estimatedValue": {
"type": "integer"
},
"notes": {
"type": "string"
},
"isIcp": {
"type": "boolean"
},
"ownerId": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"campaign": {
"type": "string"
},
"region": {
"type": "string"
},
"industry": {
"type": "string"
}
},
"required": [
"campaign",
"region",
"industry"
],
"x-apidog-orders": [
"campaign",
"region",
"industry"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"name",
"phone"
],
"x-apidog-orders": [
"name",
"email",
"phone",
"company",
"website",
"avatar",
"position",
"source",
"contactOriginConfigId",
"status",
"statusId",
"score",
"temperature",
"estimatedValue",
"notes",
"isIcp",
"ownerId",
"metadata"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Acme Corp",
"email": "contact@acme.com",
"company": "Acme",
"status": "NEW",
"temperature": "WARM"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682466-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/leads" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp",
"email": "contact@acme.com",
"company": "Acme",
"status": "NEW",
"temperature": "WARM"
}'200
{}Crm/Leads/Leads
Get Statistics
gethttps://api.falecomigo.ai/api/leads/statistics
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Statistics",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682468-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/statistics" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Leads
Get Lead
gethttps://api.falecomigo.ai/api/leads/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682469-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
Update Lead
patchhttps://api.falecomigo.ai/api/leads/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
statusstringobrigatóriotemperaturestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"temperature": {
"type": "string"
}
},
"required": [
"status",
"temperature"
],
"x-apidog-orders": [
"status",
"temperature"
],
"x-apidog-ignore-properties": []
},
"example": {
"status": "CONTACTED",
"temperature": "HOT"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682470-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/leads/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "CONTACTED",
"temperature": "HOT"
}'200
{}Crm/Leads/Leads
Delete Lead
deletehttps://api.falecomigo.ai/api/leads/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682471-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/leads/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
Get Contacts
gethttps://api.falecomigo.ai/api/leads/{leadId}/contacts
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Contacts",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682472-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/{leadId}/contacts" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
Add Contact
posthttps://api.falecomigo.ai/api/leads/{leadId}/contacts
Parâmetros de caminho
leadIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
contactIdstringobrigatóriorolestringobrigatórioisPrimarybooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Add Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"contactId": {
"type": "string"
},
"role": {
"type": "string"
},
"isPrimary": {
"type": "boolean"
}
},
"required": [
"contactId",
"role",
"isPrimary"
],
"x-apidog-orders": [
"contactId",
"role",
"isPrimary"
],
"x-apidog-ignore-properties": []
},
"example": {
"contactId": "{{contactId}}",
"role": "Decision Maker",
"isPrimary": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682473-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/leads/{leadId}/contacts" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contactId": "{{contactId}}",
"role": "Decision Maker",
"isPrimary": true
}'200
{}Crm/Leads/Leads
Update Contact
patchhttps://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}
Parâmetros de caminho
leadIdstringobrigatóriocontactIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
rolestringobrigatórioisPrimarybooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"isPrimary": {
"type": "boolean"
}
},
"required": [
"role",
"isPrimary"
],
"x-apidog-orders": [
"role",
"isPrimary"
],
"x-apidog-ignore-properties": []
},
"example": {
"role": "Technical",
"isPrimary": false
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682474-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"role": "Technical",
"isPrimary": false
}'200
{}Crm/Leads/Leads
Remove Contact
deletehttps://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}
Parâmetros de caminho
leadIdstringobrigatóriocontactIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Remove Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682476-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
Set Primary Contact
patchhttps://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}/set-primary
Parâmetros de caminho
leadIdstringobrigatóriocontactIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Set Primary Contact",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682475-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/leads/{leadId}/contacts/{contactId}/set-primary" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Leads
Get Sessions
gethttps://api.falecomigo.ai/api/leads/{leadId}/sessions
Parâmetros de caminho
leadIdstringobrigatórioParâmetros de consulta
limitstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Sessions",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Leads"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"required": true,
"example": "50",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Leads",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682477-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/{leadId}/sessions?limit=..." \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Custom Fields
Get Categories
gethttps://api.falecomigo.ai/api/custom-fields/categories
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Categories",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682478-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/custom-fields/categories" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Custom Fields
Create Category
posthttps://api.falecomigo.ai/api/custom-fields/categories
Cabeçalhos
Content-TypestringobrigatórioCorpo
namestringobrigatórioiconstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Category",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
},
"required": [
"name",
"icon"
],
"x-apidog-orders": [
"name",
"icon"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Company Info",
"icon": "building"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682479-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/custom-fields/categories" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Company Info",
"icon": "building"
}'200
{}Crm/Leads/Custom Fields
Update Category
patchhttps://api.falecomigo.ai/api/custom-fields/categories/{categoryId}
Parâmetros de caminho
categoryIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
namestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Category",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"x-apidog-orders": [
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Updated Name"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682480-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/custom-fields/categories/{categoryId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Name"
}'200
{}Crm/Leads/Custom Fields
Delete Category
deletehttps://api.falecomigo.ai/api/custom-fields/categories/{categoryId}
Parâmetros de caminho
categoryIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Category",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682481-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/custom-fields/categories/{categoryId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Custom Fields
Reorder Categories
posthttps://api.falecomigo.ai/api/custom-fields/categories/reorder
Cabeçalhos
Content-TypestringobrigatórioCorpo
categoryIdsstring[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Reorder Categories",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"categoryIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"categoryIds"
],
"x-apidog-orders": [
"categoryIds"
],
"x-apidog-ignore-properties": []
},
"example": {
"categoryIds": [
"id1",
"id2"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682482-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/custom-fields/categories/reorder" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"categoryIds": [
"id1",
"id2"
]
}'200
{}Crm/Leads/Custom Fields
Create Dropdown Field
posthttps://api.falecomigo.ai/api/custom-fields/fields
Cabeçalhos
Content-TypestringobrigatórioCorpo
categoryIdstringobrigatórionamestringobrigatóriotypestringobrigatóriooptionsobject[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Dropdown Field",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"categoryId": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"label",
"value"
],
"x-apidog-orders": [
"label",
"value"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"categoryId",
"name",
"type",
"options"
],
"x-apidog-orders": [
"categoryId",
"name",
"type",
"options"
],
"x-apidog-ignore-properties": []
},
"example": {
"categoryId": "{{categoryId}}",
"name": "Size",
"type": "dropdown",
"options": [
{
"label": "Small",
"value": "small"
},
{
"label": "Large",
"value": "large"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682484-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/custom-fields/fields" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"categoryId": "{{categoryId}}",
"name": "Size",
"type": "dropdown",
"options": [
{
"label": "Small",
"value": "small"
},
{
"label": "Large",
"value": "large"
}
]
}'200
{}Crm/Leads/Custom Fields
Update Field
patchhttps://api.falecomigo.ai/api/custom-fields/fields/{fieldId}
Parâmetros de caminho
fieldIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
namestringobrigatóriorequiredbooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Field",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "fieldId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"name",
"required"
],
"x-apidog-orders": [
"name",
"required"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Updated",
"required": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682485-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/custom-fields/fields/{fieldId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Updated",
"required": true
}'200
{}Crm/Leads/Custom Fields
Delete Field
deletehttps://api.falecomigo.ai/api/custom-fields/fields/{fieldId}
Parâmetros de caminho
fieldIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Field",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "fieldId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682486-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/custom-fields/fields/{fieldId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Custom Fields
Reorder Fields
posthttps://api.falecomigo.ai/api/custom-fields/fields/reorder
Cabeçalhos
Content-TypestringobrigatórioCorpo
categoryIdstringobrigatóriofieldIdsstring[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Reorder Fields",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"categoryId": {
"type": "string"
},
"fieldIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"categoryId",
"fieldIds"
],
"x-apidog-orders": [
"categoryId",
"fieldIds"
],
"x-apidog-ignore-properties": []
},
"example": {
"categoryId": "{{categoryId}}",
"fieldIds": [
"id1",
"id2"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682487-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/custom-fields/fields/reorder" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"categoryId": "{{categoryId}}",
"fieldIds": [
"id1",
"id2"
]
}'200
{}Crm/Leads/Custom Fields
Get Lead Values
gethttps://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Lead Values",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682488-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Custom Fields
Update Value
patchhttps://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values
Parâmetros de caminho
leadIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
fieldIdstringobrigatóriovaluestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Value",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fieldId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"fieldId",
"value"
],
"x-apidog-orders": [
"fieldId",
"value"
],
"x-apidog-ignore-properties": []
},
"example": {
"fieldId": "{{fieldId}}",
"value": "test"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682489-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"fieldId": "{{fieldId}}",
"value": "test"
}'200
{}Crm/Leads/Custom Fields
Bulk Update Values
posthttps://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values/bulk
Parâmetros de caminho
leadIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
valuesobject[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Bulk Update Values",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Custom Fields"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"x-apidog-orders": [
"fieldId",
"value"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"values"
],
"x-apidog-orders": [
"values"
],
"x-apidog-ignore-properties": []
},
"example": {
"values": [
{
"fieldId": "id1",
"value": "v1"
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Custom Fields",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682490-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/custom-fields/leads/{leadId}/values/bulk" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"values": [
{
"fieldId": "id1",
"value": "v1"
}
]
}'200
{}Crm/Leads/Opportunities
Create Opportunity
posthttps://api.falecomigo.ai/api/opportunities
Cabeçalhos
Content-TypestringobrigatórioCorpo
leadIdstringobrigatórionamestringobrigatóriovalueintegerobrigatóriostagestringobrigatórioprobabilityintegerobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Opportunity",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"leadId": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "integer"
},
"stage": {
"type": "string"
},
"probability": {
"type": "integer"
}
},
"required": [
"leadId",
"name",
"value",
"stage",
"probability"
],
"x-apidog-orders": [
"leadId",
"name",
"value",
"stage",
"probability"
],
"x-apidog-ignore-properties": []
},
"example": {
"leadId": "{{leadId}}",
"name": "Deal",
"value": 50000,
"stage": "Proposal",
"probability": 70
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682491-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/opportunities" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"leadId": "{{leadId}}",
"name": "Deal",
"value": 50000,
"stage": "Proposal",
"probability": 70
}'200
{}Crm/Leads/Opportunities
Get by Lead
gethttps://api.falecomigo.ai/api/opportunities/lead/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get by Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682492-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/opportunities/lead/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Opportunities
Get Statistics
gethttps://api.falecomigo.ai/api/opportunities/statistics
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Statistics",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682493-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/opportunities/statistics" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Opportunities
Get Opportunity
gethttps://api.falecomigo.ai/api/opportunities/{opportunityId}
Parâmetros de caminho
opportunityIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Opportunity",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [
{
"name": "opportunityId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682494-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/opportunities/{opportunityId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Opportunities
Mark as Won
patchhttps://api.falecomigo.ai/api/opportunities/{opportunityId}
Parâmetros de caminho
opportunityIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
statusstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Mark as Won",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [
{
"name": "opportunityId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
},
"required": [
"status"
],
"x-apidog-orders": [
"status"
],
"x-apidog-ignore-properties": []
},
"example": {
"status": "WON"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682496-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/opportunities/{opportunityId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "WON"
}'200
{}Crm/Leads/Opportunities
Delete Opportunity
deletehttps://api.falecomigo.ai/api/opportunities/{opportunityId}
Parâmetros de caminho
opportunityIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Opportunity",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Opportunities"
],
"parameters": [
{
"name": "opportunityId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Opportunities",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682497-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/opportunities/{opportunityId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Tasks
Create Task
posthttps://api.falecomigo.ai/api/tasks
Cabeçalhos
Content-TypestringobrigatórioCorpo
leadIdstringobrigatóriotitlestringobrigatóriodueDatestringobrigatórioprioritystringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Task",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"leadId": {
"type": "string"
},
"title": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"required": [
"leadId",
"title",
"dueDate",
"priority"
],
"x-apidog-orders": [
"leadId",
"title",
"dueDate",
"priority"
],
"x-apidog-ignore-properties": []
},
"example": {
"leadId": "{{leadId}}",
"title": "Follow up",
"dueDate": "2025-02-01",
"priority": "HIGH"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682498-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/tasks" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"leadId": "{{leadId}}",
"title": "Follow up",
"dueDate": "2025-02-01",
"priority": "HIGH"
}'200
{}Crm/Leads/Tasks
Get My Tasks
gethttps://api.falecomigo.ai/api/tasks/my
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get My Tasks",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682499-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tasks/my" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Tasks
Get Overdue Tasks
gethttps://api.falecomigo.ai/api/tasks/overdue
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Overdue Tasks",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682500-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tasks/overdue" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Crm/Leads/Tasks
Get by Lead
gethttps://api.falecomigo.ai/api/tasks/lead/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get by Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682501-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tasks/lead/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Tasks
Get Task
gethttps://api.falecomigo.ai/api/tasks/{taskId}
Parâmetros de caminho
taskIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Task",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682502-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tasks/{taskId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Tasks
Update Task
patchhttps://api.falecomigo.ai/api/tasks/{taskId}
Parâmetros de caminho
taskIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
titlestringobrigatórioprioritystringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Task",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"required": [
"title",
"priority"
],
"x-apidog-orders": [
"title",
"priority"
],
"x-apidog-ignore-properties": []
},
"example": {
"title": "Updated",
"priority": "URGENT"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682503-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/tasks/{taskId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Updated",
"priority": "URGENT"
}'200
{}Crm/Leads/Tasks
Delete Task
deletehttps://api.falecomigo.ai/api/tasks/{taskId}
Parâmetros de caminho
taskIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Task",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682505-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/tasks/{taskId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Tasks
Toggle Complete
patchhttps://api.falecomigo.ai/api/tasks/{taskId}/toggle
Parâmetros de caminho
taskIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Toggle Complete",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Tasks"
],
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Tasks",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682504-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/tasks/{taskId}/toggle" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Addresses
Create Address
posthttps://api.falecomigo.ai/api/addresses
Cabeçalhos
Content-TypestringobrigatórioCorpo
leadIdstringobrigatóriostreetstringobrigatórionumberstringobrigatóriocitystringobrigatóriostatestringobrigatóriozipCodestringobrigatórioisPrimarybooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Address",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"leadId": {
"type": "string"
},
"street": {
"type": "string"
},
"number": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"isPrimary": {
"type": "boolean"
}
},
"required": [
"leadId",
"street",
"number",
"city",
"state",
"zipCode",
"isPrimary"
],
"x-apidog-orders": [
"leadId",
"street",
"number",
"city",
"state",
"zipCode",
"isPrimary"
],
"x-apidog-ignore-properties": []
},
"example": {
"leadId": "{{leadId}}",
"street": "Av Paulista",
"number": "1000",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"isPrimary": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682506-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/addresses" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"leadId": "{{leadId}}",
"street": "Av Paulista",
"number": "1000",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100",
"isPrimary": true
}'200
{}Crm/Leads/Addresses
Get by Lead
gethttps://api.falecomigo.ai/api/addresses/lead/{leadId}
Parâmetros de caminho
leadIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get by Lead",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "leadId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682507-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/addresses/lead/{leadId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Addresses
Get Address
gethttps://api.falecomigo.ai/api/addresses/{addressId}
Parâmetros de caminho
addressIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Address",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "addressId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682508-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/addresses/{addressId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Addresses
Update Address
patchhttps://api.falecomigo.ai/api/addresses/{addressId}
Parâmetros de caminho
addressIdstringobrigatórioCabeçalhos
Content-TypestringobrigatórioCorpo
numberstringobrigatóriocomplementstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Address",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "addressId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "string"
},
"complement": {
"type": "string"
}
},
"required": [
"number",
"complement"
],
"x-apidog-orders": [
"number",
"complement"
],
"x-apidog-ignore-properties": []
},
"example": {
"number": "2000",
"complement": "Sala 101"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682509-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/addresses/{addressId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"number": "2000",
"complement": "Sala 101"
}'200
{}Crm/Leads/Addresses
Delete Address
deletehttps://api.falecomigo.ai/api/addresses/{addressId}
Parâmetros de caminho
addressIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Address",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "addressId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682511-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/addresses/{addressId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Leads/Addresses
Set Primary
patchhttps://api.falecomigo.ai/api/addresses/{addressId}/set-primary
Parâmetros de caminho
addressIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Set Primary",
"deprecated": false,
"description": "",
"tags": [
"Crm/Leads/Addresses"
],
"parameters": [
{
"name": "addressId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Crm/Leads/Addresses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24682510-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/addresses/{addressId}/set-primary" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Crm/Statuses
Get all statuses
Optionally filtered by category and isActive
gethttps://api.falecomigo.ai/api/statuses
Parâmetros de consulta
categoryanyisActivebooleanEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all statuses",
"deprecated": false,
"description": "Optionally filtered by category and isActive",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "category",
"in": "query",
"description": "",
"required": false,
"schema": {}
},
{
"name": "isActive",
"in": "query",
"description": "",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "List of statuses",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946150-run"
}Respostas
200List of statusescurl -X GET "https://api.falecomigo.ai/api/statuses"
200
[ "string" ]
Crm/Statuses
Create a new status
posthttps://api.falecomigo.ai/api/statuses
Esta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Create a new status",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
},
"required": true
},
"responses": {
"201": {
"description": "Status created",
"content": {
"application/json": {
"schema": {}
}
},
"headers": {},
"x-apidog-name": "Criado",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946149-run"
}Respostas
201Status createdcurl -X POST "https://api.falecomigo.ai/api/statuses" \ -H "Content-Type: application/json" \ -d '"string"'
201
"string"
Crm/Statuses
Get statuses by category
gethttps://api.falecomigo.ai/api/statuses/category/{category}
Parâmetros de caminho
categoryanyobrigatórioParâmetros de consulta
onlyActivebooleanIf true (default), only active statuses are returned
Esta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Get statuses by category",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "category",
"in": "path",
"description": "",
"required": true,
"example": {},
"schema": {}
},
{
"name": "onlyActive",
"in": "query",
"description": "If true (default), only active statuses are returned",
"required": false,
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "List of statuses by category",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946151-run"
}Respostas
200List of statuses by categorycurl -X GET "https://api.falecomigo.ai/api/statuses/category/{category}"200
[ "string" ]
Crm/Statuses
Get default status for a category
gethttps://api.falecomigo.ai/api/statuses/category/{category}/default
Parâmetros de caminho
categoryanyobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Get default status for a category",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "category",
"in": "path",
"description": "",
"required": true,
"example": {},
"schema": {}
}
],
"responses": {
"200": {
"description": "Default status for category",
"content": {
"application/json": {
"schema": {}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
},
"404": {
"description": "Default status not found",
"headers": {},
"x-apidog-name": "Não encontrado",
"x-apidog-ordering": 1
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946152-run"
}Respostas
200Default status for category404Default status not foundcurl -X GET "https://api.falecomigo.ai/api/statuses/category/{category}/default"200
"string"
Crm/Statuses
Initialize default statuses for organization
posthttps://api.falecomigo.ai/api/statuses/initialize
Parâmetros de consulta
categoryanyOptional category to initialize. If omitted, all categories may be initialized.
Esta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Initialize default statuses for organization",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "category",
"in": "query",
"description": "Optional category to initialize. If omitted, all categories may be initialized.",
"required": false,
"schema": {}
}
],
"responses": {
"200": {
"description": "Default statuses initialized",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946153-run"
}Respostas
200Default statuses initializedcurl -X POST "https://api.falecomigo.ai/api/statuses/initialize"
200
[ "string" ]
Crm/Statuses
Reorder statuses
puthttps://api.falecomigo.ai/api/statuses/reorder
Esta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Reorder statuses",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
},
"required": true
},
"responses": {
"200": {
"description": "Statuses reordered",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946154-run"
}Respostas
200Statuses reorderedcurl -X PUT "https://api.falecomigo.ai/api/statuses/reorder" \ -H "Content-Type: application/json" \ -d '"string"'
200
[ "string" ]
Crm/Statuses
Get a single status
gethttps://api.falecomigo.ai/api/statuses/{id}
Parâmetros de caminho
idstring · uuidobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Get a single status",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Status",
"content": {
"application/json": {
"schema": {}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
},
"404": {
"description": "Status not found",
"headers": {},
"x-apidog-name": "Não encontrado",
"x-apidog-ordering": 1
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946155-run"
}Respostas
200Status404Status not foundcurl -X GET "https://api.falecomigo.ai/api/statuses/{id}"200
"string"
Crm/Statuses
Update a status
puthttps://api.falecomigo.ai/api/statuses/{id}
Parâmetros de caminho
idstring · uuidobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Update a status",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
},
"required": true
},
"responses": {
"200": {
"description": "Updated status",
"content": {
"application/json": {
"schema": {}
}
},
"headers": {},
"x-apidog-name": "Correto",
"x-apidog-ordering": 0
},
"404": {
"description": "Status not found",
"headers": {},
"x-apidog-name": "Não encontrado",
"x-apidog-ordering": 1
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946156-run"
}Respostas
200Updated status404Status not foundcurl -X PUT "https://api.falecomigo.ai/api/statuses/{id}" \
-H "Content-Type: application/json" \
-d '"string"'200
"string"
Crm/Statuses
Delete a status
deletehttps://api.falecomigo.ai/api/statuses/{id}
Parâmetros de caminho
idstring · uuidobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete a status",
"deprecated": false,
"description": "",
"tags": [
"Crm/Statuses",
"Statuses"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"example": "",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "Status deleted",
"headers": {},
"x-apidog-name": "Sem conteúdo",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Crm/Statuses",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-24946157-run"
}Respostas
204Status deletedcurl -X DELETE "https://api.falecomigo.ai/api/statuses/{id}"Features/Dashboard/v1
Performance
gethttps://api.falecomigo.ai/api/dashboard/performance
Parâmetros de consulta
customerIdstringobrigatórioThe customer id.
interval"Yesterday" | "Today" | "Last7Days" | "Last30Days" | "Last90Days"obrigatórioThe time interval to perform the query.
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Performance",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v1"
],
"parameters": [
{
"name": "customerId",
"in": "query",
"description": "The customer id.",
"required": true,
"example": "dd4e08f9-ad5a-4881-90a4-476ee6da8e8b",
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval to perform the query.",
"required": true,
"example": "Last7Days",
"schema": {
"type": "string",
"enum": [
"Yesterday",
"Today",
"Last7Days",
"Last30Days",
"Last90Days"
],
"x-apidog-enum": [
{
"value": "Yesterday",
"name": "",
"description": ""
},
{
"value": "Today",
"name": "",
"description": ""
},
{
"value": "Last7Days",
"name": "",
"description": ""
},
{
"value": "Last30Days",
"name": "",
"description": ""
},
{
"value": "Last90Days",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v1",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18516162-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard/performance?customerId=...&interval=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Dashboard/v1
Grouped Performance
gethttps://api.falecomigo.ai/api/dashboard/performance/grouped
Parâmetros de consulta
customerIdstringThe customer id.
interval"Yesterday" | "Today" | "Last7Days" | "Last30Days" | "Last90Days"obrigatórioThe time interval to perform the query.
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Grouped Performance",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v1"
],
"parameters": [
{
"name": "customerId",
"in": "query",
"description": "The customer id.",
"required": false,
"example": "dd4e08f9-ad5a-4881-90a4-476ee6da8e8b",
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval to perform the query.",
"required": true,
"example": "Last7Days",
"schema": {
"type": "string",
"enum": [
"Yesterday",
"Today",
"Last7Days",
"Last30Days",
"Last90Days"
],
"x-apidog-enum": [
{
"value": "Yesterday",
"name": "",
"description": ""
},
{
"value": "Today",
"name": "",
"description": ""
},
{
"value": "Last7Days",
"name": "",
"description": ""
},
{
"value": "Last30Days",
"name": "",
"description": ""
},
{
"value": "Last90Days",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v1",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18516200-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard/performance/grouped?interval=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Dashboard/v1
Phone Call
gethttps://api.falecomigo.ai/api/dashboard/phone-call
Parâmetros de consulta
customerIdstringobrigatórioThe customer id.
interval"Yesterday" | "Today" | "Last7Days" | "Last30Days" | "Last90Days"obrigatórioThe time interval to perform the query.
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Phone Call",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v1"
],
"parameters": [
{
"name": "customerId",
"in": "query",
"description": "The customer id.",
"required": true,
"example": "dd4e08f9-ad5a-4881-90a4-476ee6da8e8b",
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval to perform the query.",
"required": true,
"example": "Last7Days",
"schema": {
"type": "string",
"enum": [
"Yesterday",
"Today",
"Last7Days",
"Last30Days",
"Last90Days"
],
"x-apidog-enum": [
{
"value": "Yesterday",
"name": "",
"description": ""
},
{
"value": "Today",
"name": "",
"description": ""
},
{
"value": "Last7Days",
"name": "",
"description": ""
},
{
"value": "Last30Days",
"name": "",
"description": ""
},
{
"value": "Last90Days",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v1",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18516238-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard/phone-call?customerId=...&interval=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Dashboard/v1
Conversation
gethttps://api.falecomigo.ai/api/dashboard/conversation
Parâmetros de consulta
customerIdstringobrigatórioThe customer id.
interval"Yesterday" | "Today" | "Last7Days" | "Last30Days" | "Last90Days"obrigatórioThe time interval to perform the query.
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Conversation",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v1"
],
"parameters": [
{
"name": "customerId",
"in": "query",
"description": "The customer id.",
"required": true,
"example": "dd4e08f9-ad5a-4881-90a4-476ee6da8e8b",
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "The time interval to perform the query.",
"required": true,
"example": "Last7Days",
"schema": {
"type": "string",
"enum": [
"Yesterday",
"Today",
"Last7Days",
"Last30Days",
"Last90Days"
],
"x-apidog-enum": [
{
"value": "Yesterday",
"name": "",
"description": ""
},
{
"value": "Today",
"name": "",
"description": ""
},
{
"value": "Last7Days",
"name": "",
"description": ""
},
{
"value": "Last30Days",
"name": "",
"description": ""
},
{
"value": "Last90Days",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v1",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18524796-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard/conversation?customerId=...&interval=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Dashboard/v1
Grouped Conversation
gethttps://api.falecomigo.ai/api/dashboard/conversation/grouped
Parâmetros de consulta
customerIdstringobrigatórioThe customer id.
interval"Yesterday" | "Today" | "Last7Days" | "Last30Days" | "Last90Days"obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Grouped Conversation",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v1"
],
"parameters": [
{
"name": "customerId",
"in": "query",
"description": "The customer id.",
"required": true,
"example": "dd4e08f9-ad5a-4881-90a4-476ee6da8e8b",
"schema": {
"type": "string"
}
},
{
"name": "interval",
"in": "query",
"description": "",
"required": true,
"example": "Last7Days",
"schema": {
"type": "string",
"enum": [
"Yesterday",
"Today",
"Last7Days",
"Last30Days",
"Last90Days"
],
"x-apidog-enum": [
{
"value": "Yesterday",
"name": "",
"description": ""
},
{
"value": "Today",
"name": "",
"description": ""
},
{
"value": "Last7Days",
"name": "",
"description": ""
},
{
"value": "Last30Days",
"name": "",
"description": ""
},
{
"value": "Last90Days",
"name": "",
"description": ""
}
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v1",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18524798-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard/conversation/grouped?customerId=...&interval=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Dashboard/v2
Team Metrics
gethttps://api.falecomigo.ai/api/dashboard-v2/team
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Team Metrics",
"deprecated": false,
"description": "",
"tags": [
"Features/Dashboard/v2"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Dashboard/v2",
"x-apidog-status": "developing",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23663494-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/dashboard-v2/team" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Label
List
gethttps://api.falecomigo.ai/api/labels
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804895-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/labels" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
[ "string" ]
Features/Label
Create
posthttps://api.falecomigo.ai/api/labels
Corpo
category"DASHBOARD" | "CAMPAIGN" | "INTEGRATION" | "CONVERSATION" | "OTHER"obrigatóriogroup
namestringobrigatórioname
isActivebooleanAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "group",
"enum": [
"DASHBOARD",
"CAMPAIGN",
"INTEGRATION",
"CONVERSATION",
"OTHER"
],
"x-apidog-enum": [
{
"value": "DASHBOARD",
"name": "DASHBOARD",
"description": ""
},
{
"value": "CAMPAIGN",
"name": "CAMPAIGN",
"description": ""
},
{
"value": "INTEGRATION",
"name": "INTEGRATION",
"description": ""
},
{
"value": "CONVERSATION",
"name": "CONVERSATION",
"description": ""
},
{
"value": "OTHER",
"name": "OTHER",
"description": ""
}
]
},
"name": {
"type": "string",
"description": "name"
},
"isActive": {
"type": "boolean"
}
},
"x-apidog-orders": [
"category",
"name",
"isActive"
],
"required": [
"category",
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "teste",
"category": "DASHBOARD",
"isActive": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804921-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/labels" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "teste",
"category": "DASHBOARD",
"isActive": true
}'200
[ "string" ]
Features/Label
Show
gethttps://api.falecomigo.ai/api/labels/{labelId}
Parâmetros de caminho
labelIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [
{
"name": "labelId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804896-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/labels/{labelId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
[ "string" ]
Features/Label
Update
puthttps://api.falecomigo.ai/api/labels/{labelId}
Parâmetros de caminho
labelIdstringobrigatórioCorpo
category"DASHBOARD" | "CAMPAIGN" | "INTEGRATION" | "CONVERSATION" | "OTHER"obrigatóriogroup
namestringobrigatórioname
isActivebooleanisActive
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [
{
"name": "labelId",
"in": "path",
"description": "",
"required": true,
"example": "f045bacd-6296-4cc7-a682-5baffe8f4225",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "group",
"enum": [
"DASHBOARD",
"CAMPAIGN",
"INTEGRATION",
"CONVERSATION",
"OTHER"
],
"x-apidog-enum": [
{
"value": "DASHBOARD",
"name": "DASHBOARD",
"description": ""
},
{
"value": "CAMPAIGN",
"name": "CAMPAIGN",
"description": ""
},
{
"value": "INTEGRATION",
"name": "INTEGRATION",
"description": ""
},
{
"value": "CONVERSATION",
"name": "CONVERSATION",
"description": ""
},
{
"value": "OTHER",
"name": "OTHER",
"description": ""
}
]
},
"name": {
"type": "string",
"description": "name"
},
"isActive": {
"type": "boolean",
"description": "isActive"
}
},
"x-apidog-orders": [
"category",
"name",
"isActive"
],
"required": [
"category",
"name"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "teste2",
"category": "DASHBOARD",
"isActive": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804934-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/labels/{labelId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "teste2",
"category": "DASHBOARD",
"isActive": true
}'200
[ "string" ]
Features/Label
Delete
deletehttps://api.falecomigo.ai/api/labels/{labelId}
Parâmetros de caminho
labelIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [
{
"name": "labelId",
"in": "path",
"description": "",
"required": true,
"example": "f045bacd-6296-4cc7-a682-5baffe8f4225",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804937-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/labels/{labelId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
[ "string" ]
Features/Label
List by Category
gethttps://api.falecomigo.ai/api/labels/category/{category}
Parâmetros de caminho
categorystringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List by Category",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [
{
"name": "category",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804910-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/labels/category/{category}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
[ "string" ]
Features/Label
Stats
gethttps://api.falecomigo.ai/api/labels/stats
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Stats",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804919-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/labels/stats" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
[ "string" ]
Features/Label
Toggle active status
patchhttps://api.falecomigo.ai/api/labels/{labelId}/toggle
Parâmetros de caminho
labelIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Toggle active status",
"deprecated": false,
"description": "",
"tags": [
"Features/Label"
],
"parameters": [
{
"name": "labelId",
"in": "path",
"description": "",
"required": true,
"example": "f045bacd-6296-4cc7-a682-5baffe8f4225",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"headers": {},
"x-apidog-name": "OK",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Label",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18804938-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/labels/{labelId}/toggle" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
[ "string" ]
Features/Tabulation
List
gethttps://api.falecomigo.ai/api/tabulations
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494552-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tabulations" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/Tabulation
Create
posthttps://api.falecomigo.ai/api/tabulations
Corpo
namestringobrigatóriodescriptionstringobrigatóriobackgroundColorstringobrigatórioautoTabulationbooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"autoTabulation": {
"type": "boolean"
}
},
"required": [
"name",
"description",
"backgroundColor",
"autoTabulation"
],
"x-apidog-orders": [
"name",
"description",
"backgroundColor",
"autoTabulation"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "tabulação teste",
"description": "Descrição detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494554-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/tabulations" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "tabulação teste",
"description": "Descrição detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false
}'200
{}Features/Tabulation
Show
gethttps://api.falecomigo.ai/api/tabulations/{tabulationId}
Parâmetros de caminho
tabulationIdstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Show",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [
{
"name": "tabulationId",
"in": "path",
"description": "",
"required": true,
"example": "bb5e9d1d-8424-474c-8d57-af32990807f6",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494553-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/tabulations/{tabulationId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Features/Tabulation
Update
puthttps://api.falecomigo.ai/api/tabulations/{tabulationId}
Parâmetros de caminho
tabulationIdstringobrigatórioCorpo
namestringobrigatóriodescriptionstringobrigatóriobackgroundColorstringobrigatórioautoTabulationbooleanobrigatóriointegration_idsstring[]obrigatóriotabulation_settingsobject[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [
{
"name": "tabulationId",
"in": "path",
"description": "",
"required": true,
"example": "bb5e9d1d-8424-474c-8d57-af32990807f6",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"autoTabulation": {
"type": "boolean"
},
"integration_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"tabulation_settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tabulationId": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
},
"x-apidog-orders": [
"tabulationId",
"name",
"type",
"settings"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"name",
"description",
"backgroundColor",
"autoTabulation",
"integration_ids",
"tabulation_settings"
],
"x-apidog-orders": [
"name",
"description",
"backgroundColor",
"autoTabulation",
"integration_ids",
"tabulation_settings"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "tabulação teste 2",
"description": "Descrição2222 detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false,
"integration_ids": [],
"tabulation_settings": [
{
"tabulationId": "",
"name": "",
"type": "",
"settings": {}
}
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494555-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/tabulations/{tabulationId}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "tabulação teste 2",
"description": "Descrição2222 detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false,
"integration_ids": [],
"tabulation_settings": [
{
"tabulationId": "",
"name": "",
"type": "",
"settings": {}
}
]
}'200
{}Features/Tabulation
Associate
patchhttps://api.falecomigo.ai/api/tabulation/associate
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Associate",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
},
"example": {
"tabulationId": "",
"contacId": "",
"sessionId": ""
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18534072-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/tabulation/associate" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"tabulationId": "",
"contacId": "",
"sessionId": ""
}'200
{}Features/Tabulation
Disassociate
patchhttps://api.falecomigo.ai/api/tabulation/disassociate
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Disassociate",
"deprecated": false,
"description": "",
"tags": [
"Features/Tabulation"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
},
"example": {
"tabulationId": "",
"sessionId": ""
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/Tabulation",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-18534073-run"
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/tabulation/disassociate" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"tabulationId": "",
"sessionId": ""
}'200
{}Features/URL Shortener/🔐 Admin - CRUD
List Short Links - Filtered
Lista short links com filtros aplicados.
gethttps://api.falecomigo.ai/api/short-links
Parâmetros de consulta
pagestringobrigatóriopageSizestringobrigatórioisActivestringobrigatórioApenas links ativos
tagsstringobrigatórioFiltrar por tags (separadas por vírgula)
campaignIdstringFiltrar por campanha (opcional)
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List Short Links - Filtered",
"deprecated": false,
"description": "Lista short links com filtros aplicados.",
"tags": [
"Features/URL Shortener/🔐 Admin - CRUD"
],
"parameters": [
{
"name": "page",
"in": "query",
"description": "",
"required": true,
"example": "1",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "",
"required": true,
"example": "20",
"schema": {
"type": "string"
}
},
{
"name": "isActive",
"in": "query",
"description": "Apenas links ativos",
"required": true,
"example": "true",
"schema": {
"type": "string"
}
},
{
"name": "tags",
"in": "query",
"description": "Filtrar por tags (separadas por vírgula)",
"required": true,
"example": "marketing,email",
"schema": {
"type": "string"
}
},
{
"name": "campaignId",
"in": "query",
"description": "Filtrar por campanha (opcional)",
"required": false,
"example": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/🔐 Admin - CRUD",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999201-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/short-links?page=...&pageSize=...&isActive=...&tags=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/URL Shortener/🔐 Admin - CRUD
Create Short Link - Campaign
Link associado a uma campanha de marketing.
posthttps://api.falecomigo.ai/api/short-links
Cabeçalhos
Content-TypestringobrigatórioCorpo
originalUrlstringobrigatóriocustomAliasstringobrigatóriocampaignIdstringobrigatóriomaxClicksintegerobrigatórioexpiresAtstringobrigatórioutmobjectobrigatóriotagsstring[]obrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create Short Link - Campaign",
"deprecated": false,
"description": "Link associado a uma campanha de marketing.",
"tags": [
"Features/URL Shortener/🔐 Admin - CRUD"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"originalUrl": {
"type": "string"
},
"customAlias": {
"type": "string"
},
"campaignId": {
"type": "string"
},
"maxClicks": {
"type": "integer"
},
"expiresAt": {
"type": "string"
},
"utm": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"medium": {
"type": "string"
},
"campaign": {
"type": "string"
}
},
"required": [
"source",
"medium",
"campaign"
],
"x-apidog-orders": [
"source",
"medium",
"campaign"
],
"x-apidog-ignore-properties": []
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"originalUrl",
"customAlias",
"campaignId",
"maxClicks",
"expiresAt",
"utm",
"tags"
],
"x-apidog-orders": [
"originalUrl",
"customAlias",
"campaignId",
"maxClicks",
"expiresAt",
"utm",
"tags"
],
"x-apidog-ignore-properties": []
},
"example": {
"originalUrl": "https://falecomigo.ai/promo-black-friday",
"customAlias": "bf2025",
"campaignId": "123e4567-e89b-12d3-a456-426614174000",
"maxClicks": 5000,
"expiresAt": "2025-11-30T23:59:59.000Z",
"utm": {
"source": "instagram",
"medium": "social",
"campaign": "black-friday-2025"
},
"tags": [
"promocao",
"black-friday",
"social-media"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/🔐 Admin - CRUD",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999199-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/short-links" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"originalUrl": "https://falecomigo.ai/promo-black-friday",
"customAlias": "bf2025",
"campaignId": "123e4567-e89b-12d3-a456-426614174000",
"maxClicks": 5000,
"expiresAt": "2025-11-30T23:59:59.000Z",
"utm": {
"source": "instagram",
"medium": "social",
"campaign": "black-friday-2025"
},
"tags": [
"promocao",
"black-friday",
"social-media"
]
}'200
{}Features/URL Shortener/🔐 Admin - CRUD
Get Short Link by ID
Busca detalhes completos de um short link por ID.
gethttps://api.falecomigo.ai/api/short-links/shortLinkId
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Short Link by ID",
"deprecated": false,
"description": "Busca detalhes completos de um short link por ID.",
"tags": [
"Features/URL Shortener/🔐 Admin - CRUD"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/🔐 Admin - CRUD",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999202-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/short-links/shortLinkId" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/URL Shortener/🔐 Admin - CRUD
Update Short Link
Atualiza configurações de um short link existente.
puthttps://api.falecomigo.ai/api/short-links/shortLinkId
Cabeçalhos
Content-TypestringobrigatórioCorpo
isActivebooleanobrigatóriomaxClicksintegerobrigatórioexpiresAtstringobrigatóriotagsstring[]obrigatóriometadataobjectobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update Short Link",
"deprecated": false,
"description": "Atualiza configurações de um short link existente.",
"tags": [
"Features/URL Shortener/🔐 Admin - CRUD"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean"
},
"maxClicks": {
"type": "integer"
},
"expiresAt": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"metadata": {
"type": "object",
"properties": {
"lastUpdate": {
"type": "string"
},
"updatedBy": {
"type": "string"
}
},
"required": [
"lastUpdate",
"updatedBy"
],
"x-apidog-orders": [
"lastUpdate",
"updatedBy"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"isActive",
"maxClicks",
"expiresAt",
"tags",
"metadata"
],
"x-apidog-orders": [
"isActive",
"maxClicks",
"expiresAt",
"tags",
"metadata"
],
"x-apidog-ignore-properties": []
},
"example": {
"isActive": true,
"maxClicks": 2000,
"expiresAt": "2026-12-31T23:59:59.000Z",
"tags": [
"marketing",
"promocao",
"updated"
],
"metadata": {
"lastUpdate": "2025-01-09",
"updatedBy": "Admin"
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/🔐 Admin - CRUD",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999203-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/short-links/shortLinkId" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"isActive": true,
"maxClicks": 2000,
"expiresAt": "2026-12-31T23:59:59.000Z",
"tags": [
"marketing",
"promocao",
"updated"
],
"metadata": {
"lastUpdate": "2025-01-09",
"updatedBy": "Admin"
}
}'200
{}Features/URL Shortener/🔐 Admin - CRUD
Delete Short Link
Remove permanentemente um short link.
deletehttps://api.falecomigo.ai/api/short-links/shortLinkId
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete Short Link",
"deprecated": false,
"description": "Remove permanentemente um short link.",
"tags": [
"Features/URL Shortener/🔐 Admin - CRUD"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/🔐 Admin - CRUD",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999204-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/short-links/shortLinkId" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Features/URL Shortener/🔓 Public Routes
Redirect - With Password
Redireciona após validar senha do link protegido.
gethttps://api.falecomigo.ai/abc123
Parâmetros de consulta
passwordstringobrigatórioSenha para links protegidos
Esta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Redirect - With Password",
"deprecated": false,
"description": "Redireciona após validar senha do link protegido.",
"tags": [
"Features/URL Shortener/🔓 Public Routes"
],
"parameters": [
{
"name": "password",
"in": "query",
"description": "Senha para links protegidos",
"required": true,
"example": "senha123",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Features/URL Shortener/🔓 Public Routes",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999195-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/abc123?password=..."
200
{}Features/URL Shortener/🔓 Public Routes
Verify Password
Verifica senha de link protegido sem fazer o redirect.
posthttps://api.falecomigo.ai/abc123/verify
Cabeçalhos
Content-TypestringobrigatórioCorpo
passwordstringobrigatórioEsta operação não exige token segundo a especificação.
Estrutura completa, exemplos e respostas
{
"summary": "Verify Password",
"deprecated": false,
"description": "Verifica senha de link protegido sem fazer o redirect.",
"tags": [
"Features/URL Shortener/🔓 Public Routes"
],
"parameters": [
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"example": "application/json",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"x-apidog-orders": [
"password"
],
"x-apidog-ignore-properties": []
},
"example": {
"password": "senha123"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [],
"x-apidog-folder": "Features/URL Shortener/🔓 Public Routes",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999196-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/abc123/verify" \
-H "Content-Type: application/json" \
-d '{
"password": "senha123"
}'200
{}Features/URL Shortener/📊 Analytics
Get Stats - Last 7 Days
Estatísticas dos últimos 7 dias.
gethttps://api.falecomigo.ai/api/short-links/shortLinkId/stats
Parâmetros de consulta
startDatestringobrigatórioendDatestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get Stats - Last 7 Days",
"deprecated": false,
"description": "Estatísticas dos últimos 7 dias.",
"tags": [
"Features/URL Shortener/📊 Analytics"
],
"parameters": [
{
"name": "startDate",
"in": "query",
"description": "",
"required": true,
"example": "{{seven_days_ago}}",
"schema": {
"type": "string"
}
},
{
"name": "endDate",
"in": "query",
"description": "",
"required": true,
"example": "{{today}}",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Features/URL Shortener/📊 Analytics",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-23999207-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/short-links/shortLinkId/stats?startDate=...&endDate=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Integration
List integrations
gethttps://api.falecomigo.ai/api/integrations
Parâmetros de consulta
connectedstringobrigatóriosearchstringAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List integrations",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "connected",
"in": "query",
"description": "",
"required": true,
"example": "true",
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "",
"required": false,
"example": "",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494496-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/integrations?connected=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Integration
Create integration
posthttps://api.falecomigo.ai/api/integrations
Corpo
namestringobrigatóriocustomerIdstringobrigatórioorganizationIdstringobrigatórioproviderIdstringobrigatóriosettingsobjectobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"customerId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"providerId": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"integration": {
"type": "string"
},
"additional_settings": {
"type": "object",
"properties": {
"rejectCall": {
"type": "boolean"
},
"msgCall": {
"type": "boolean"
},
"groupsIgnore": {
"type": "boolean"
},
"alwaysOnline": {
"type": "boolean"
},
"readMessages": {
"type": "boolean"
},
"readStatus": {
"type": "boolean"
}
},
"required": [
"rejectCall",
"msgCall",
"groupsIgnore",
"alwaysOnline",
"readMessages",
"readStatus"
],
"x-apidog-orders": [
"rejectCall",
"msgCall",
"groupsIgnore",
"alwaysOnline",
"readMessages",
"readStatus"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"name",
"phoneNumber",
"integration",
"additional_settings"
],
"x-apidog-orders": [
"name",
"phoneNumber",
"integration",
"additional_settings"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"name",
"customerId",
"organizationId",
"providerId",
"settings"
],
"x-apidog-orders": [
"name",
"customerId",
"organizationId",
"providerId",
"settings"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Samu Zap",
"customerId": "f78819a0-d534-418b-bec2-f282ae49818f",
"organizationId": "3d9ec732-2165-49a5-aed7-8760274f1602",
"providerId": "3c285679-15f7-44f2-9730-960a00978cf8",
"settings": {
"name": "falecomigoai-5534991189081",
"phoneNumber": "5534991189081",
"integration": "WHATSAPP-BAILEYS",
"additional_settings": {
"rejectCall": false,
"msgCall": false,
"groupsIgnore": false,
"alwaysOnline": false,
"readMessages": false,
"readStatus": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494498-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/integrations" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Samu Zap",
"customerId": "f78819a0-d534-418b-bec2-f282ae49818f",
"organizationId": "3d9ec732-2165-49a5-aed7-8760274f1602",
"providerId": "3c285679-15f7-44f2-9730-960a00978cf8",
"settings": {
"name": "falecomigoai-5534991189081",
"phoneNumber": "5534991189081",
"integration": "WHATSAPP-BAILEYS",
"additional_settings": {
"rejectCall": false,
"msgCall": false,
"groupsIgnore": false,
"alwaysOnline": false,
"readMessages": false,
"readStatus": false
}
}
}'200
{}Integration
List integration
gethttps://api.falecomigo.ai/api/integrations/{integration_id}
Parâmetros de caminho
integration_idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "List integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "c98c856e-d463-4592-ae40-ee51ad62c352",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494497-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/integrations/{integration_id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration
Update integration
puthttps://api.falecomigo.ai/api/integrations/{integration_id}
Parâmetros de caminho
integration_idstringobrigatórioCorpo
namestringobrigatóriosettingsobjectobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Update integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "c98c856e-d463-4592-ae40-ee51ad62c352",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"settings": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"integration": {
"type": "string"
},
"additional_settings": {
"type": "object",
"properties": {
"rejectCall": {
"type": "boolean"
},
"msgCall": {
"type": "boolean"
},
"groupsIgnore": {
"type": "boolean"
},
"alwaysOnline": {
"type": "boolean"
},
"readMessages": {
"type": "boolean"
},
"readStatus": {
"type": "boolean"
}
},
"required": [
"rejectCall",
"msgCall",
"groupsIgnore",
"alwaysOnline",
"readMessages",
"readStatus"
],
"x-apidog-orders": [
"rejectCall",
"msgCall",
"groupsIgnore",
"alwaysOnline",
"readMessages",
"readStatus"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"name",
"phoneNumber",
"integration",
"additional_settings"
],
"x-apidog-orders": [
"name",
"phoneNumber",
"integration",
"additional_settings"
],
"x-apidog-ignore-properties": []
}
},
"required": [
"name",
"settings"
],
"x-apidog-orders": [
"name",
"settings"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Samu Zap",
"settings": {
"name": "falecomigoai-5534991189081",
"phoneNumber": "5534991189081",
"integration": "WHATSAPP-BAILEYS",
"additional_settings": {
"rejectCall": false,
"msgCall": false,
"groupsIgnore": false,
"alwaysOnline": false,
"readMessages": false,
"readStatus": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494503-run"
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/integrations/{integration_id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Samu Zap",
"settings": {
"name": "falecomigoai-5534991189081",
"phoneNumber": "5534991189081",
"integration": "WHATSAPP-BAILEYS",
"additional_settings": {
"rejectCall": false,
"msgCall": false,
"groupsIgnore": false,
"alwaysOnline": false,
"readMessages": false,
"readStatus": false
}
}
}'200
{}Integration
Delete integration
deletehttps://api.falecomigo.ai/api/integrations/{integration_id}
Parâmetros de caminho
integration_idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Delete integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "b92116eb-50e9-4c25-bc8d-9d0c5696603f",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494504-run"
}Respostas
200curl -X DELETE "https://api.falecomigo.ai/api/integrations/{integration_id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration
Connect integration
posthttps://api.falecomigo.ai/api/integrations/{integration_id}/connect
Parâmetros de caminho
integration_idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Connect integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "acfbc4db-41ca-4765-836b-3ea6556abaf5",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494499-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/integrations/{integration_id}/connect" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration
Connect evo integration
posthttps://api.falecomigo.ai/api/integrations/connect
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Connect evo integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494500-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/integrations/connect" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Integration
Sign QRCode
posthttps://api.falecomigo.ai/api/integrations/{integration_id}/sign-qr
Parâmetros de caminho
integration_idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Sign QRCode",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "903a90c9-8068-4691-8bd0-c7996f3358c0",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494501-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/integrations/{integration_id}/sign-qr" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration
Disconnect integration
posthttps://api.falecomigo.ai/api/integrations/{integration_id}/disconnect
Parâmetros de caminho
integration_idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Disconnect integration",
"deprecated": false,
"description": "",
"tags": [
"Integration"
],
"parameters": [
{
"name": "integration_id",
"in": "path",
"description": "",
"required": true,
"example": "b92116eb-50e9-4c25-bc8d-9d0c5696603f",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494502-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/integrations/{integration_id}/disconnect" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration/Connection
Get all connections
gethttps://api.falecomigo.ai/api/connection
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Get all connections",
"deprecated": false,
"description": "",
"tags": [
"Integration/Connection"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration/Connection",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19753560-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/connection" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Integration/Connection
Create a connection
posthttps://api.falecomigo.ai/api/connection
Corpo
namestringobrigatóriodescriptionstringobrigatórioiconstringobrigatóriotype"OAUTH" | "API_KEY"obrigatórioconnectionKeystringobrigatóriourlstringobrigatórioscopestringfieldsobjectenabledbooleanobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Create a connection",
"deprecated": false,
"description": "",
"tags": [
"Integration/Connection"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"OAUTH",
"API_KEY"
],
"x-apidog-enum": [
{
"value": "OAUTH",
"name": "",
"description": ""
},
{
"value": "API_KEY",
"name": "",
"description": ""
}
]
},
"connectionKey": {
"type": "string"
},
"url": {
"type": "string"
},
"scope": {
"type": "string"
},
"fields": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
},
"enabled": {
"type": "boolean"
}
},
"x-apidog-orders": [
"name",
"description",
"icon",
"type",
"connectionKey",
"url",
"scope",
"fields",
"enabled"
],
"required": [
"name",
"description",
"type",
"enabled",
"url",
"icon",
"connectionKey"
],
"x-apidog-ignore-properties": []
},
"example": {
"name": "Google Calendar",
"description": "Integre com a sua agenda do Google.",
"icon": "https://storage.falecomigo.ai/falecomigo.ai/assets%2Fgoogle-calendar-icon.png",
"type": "OAUTH",
"connectionKey": "google-calendar",
"url": "https://accounts.google.com/o/oauth2/v2/auth",
"scope": "https://www.googleapis.com/auth/userinfo.email;https://www.googleapis.com/auth/userinfo.profile;openid;https://www.googleapis.com/auth/calendar.settings.readonly;https://www.googleapis.com/auth/calendar.freebusy;https://www.googleapis.com/auth/calendar.events;https://www.googleapis.com/auth/calendar.events.owned;https://www.googleapis.com/auth/calendar.events.owned.readonly",
"enabled": true
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration/Connection",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19753739-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/connection" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Google Calendar",
"description": "Integre com a sua agenda do Google.",
"icon": "https://storage.falecomigo.ai/falecomigo.ai/assets%2Fgoogle-calendar-icon.png",
"type": "OAUTH",
"connectionKey": "google-calendar",
"url": "https://accounts.google.com/o/oauth2/v2/auth",
"scope": "https://www.googleapis.com/auth/userinfo.email;https://www.googleapis.com/auth/userinfo.profile;openid;https://www.googleapis.com/auth/calendar.settings.readonly;https://www.googleapis.com/auth/calendar.freebusy;https://www.googleapis.com/auth/calendar.events;https://www.googleapis.com/auth/calendar.events.owned;https://www.googleapis.com/auth/calendar.events.owned.readonly",
"enabled": true
}'200
{}Integration/Connection
Find one connection
gethttps://api.falecomigo.ai/api/connection/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Find one connection",
"deprecated": false,
"description": "",
"tags": [
"Integration/Connection"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration/Connection",
"x-apidog-status": "released",
"x-apidog-maintainer": "Sam",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-19753633-run"
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/connection/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"200
{}Integration/OauthInstagram
posthttps://api.falecomigo.ai/api/oauth/instagram/callback
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Instagram",
"deprecated": false,
"description": "",
"tags": [
"Integration/Oauth"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration/Oauth",
"x-apidog-status": "developing",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-22590342-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/oauth/instagram/callback" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Integration/OauthWhatsApp
posthttps://api.falecomigo.ai/api/oauth/whatsapp/callback
Autenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "WhatsApp",
"deprecated": false,
"description": "",
"tags": [
"Integration/Oauth"
],
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-ignore-properties": [],
"x-apidog-orders": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Integration/Oauth",
"x-apidog-status": "developing",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-28129293-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/oauth/whatsapp/callback" \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
200
{}Shared/Utils
Process Dispatch File
posthttps://api.falecomigo.ai/api/util/shots/file-content
Corpo
fileUrlstringobrigatóriofileTypestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Process Dispatch File",
"deprecated": false,
"description": "",
"tags": [
"Shared/Utils"
],
"parameters": [],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"fileUrl": {
"example": "https://storage.falecomigo.ai/dispatch-files-upload/uploads/1741959315854-Larissa%2014-03.xlsx",
"type": "string"
},
"fileType": {
"example": "XLSX",
"type": "string"
}
},
"required": [
"fileUrl",
"fileType"
]
},
"example": {
"fileUrl": "https://storage.falecomigo.ai/dispatch-files-upload/uploads/1741959315854-Larissa%2014-03.xlsx",
"fileType": "XLSX"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Shared/Utils",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494560-run"
}Respostas
200Envie o corpo como
multipart/form-data. Consulte a estrutura completa desta operação e o arquivo OpenAPI para os campos e exemplos.200
{}Shared/Utils
Validate Phones
posthttps://api.falecomigo.ai/api/util/shots/validate-phones
Corpo
dataobject[]obrigatórioselectedPhoneColumnstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"summary": "Validate Phones",
"deprecated": false,
"description": "",
"tags": [
"Shared/Utils"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"loja": {
"type": "string"
},
"cliente": {
"type": "string"
},
"vendedor": {
"type": "string"
},
"telefone": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"error": {
"type": "string"
}
},
"required": [
"type",
"error"
],
"x-apidog-orders": [
"type",
"error"
],
"x-apidog-ignore-properties": []
}
}
},
"required": [
"loja",
"cliente",
"vendedor",
"telefone",
"errors"
],
"x-apidog-orders": [
"loja",
"cliente",
"vendedor",
"telefone",
"errors"
],
"x-apidog-ignore-properties": []
}
},
"selectedPhoneColumn": {
"type": "string"
}
},
"required": [
"data",
"selectedPhoneColumn"
],
"x-apidog-orders": [
"data",
"selectedPhoneColumn"
],
"x-apidog-ignore-properties": []
},
"example": {
"data": [
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "GRACE APARECIDA RODRIGUES ALVES",
"vendedor": "ANDRE COELHO MICHELIN",
"telefone": "(11) 980661162 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "WILLIAM VICENTE DE MELO",
"vendedor": "MARCELO RANGEL",
"telefone": "(19) 992194465 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "JULIANA MARIA ARRUDA VIEIRA",
"vendedor": "JULIANE JOLECY NOVAES ANTUNES",
"telefone": "(19) 982088899 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "IVAN NIERO MIRANDA",
"vendedor": "JULIANE JOLECY NOVAES ANTUNES",
"telefone": "(19) 981182751 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "EDUARDO VIEIRA ALMEIDA",
"vendedor": "EUNICE HAYDEN",
"telefone": "(19) 991367063 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MARCIA REGINA GONÇALVES CASAREJOS",
"vendedor": "JUANELIZ WILLIAN SANTIAN",
"telefone": "(11) 972063335 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MICHELE CRISTINA CARDOSO BEZERRA",
"vendedor": "MATHEUS DE SOUZA",
"telefone": "(11) 981168164 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "JOSE TEODORO FILHO",
"vendedor": "MARCELO RANGEL",
"telefone": "(11) 995695609 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "PAULO FERNANDES DE OLIVEIRA",
"vendedor": "ANTONIO CARLOS PEREIRA DA SILVA",
"telefone": "(19) 993424898 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "RUI CARLOS PEDREIRA PASSOS",
"vendedor": "RODRIGO APARECIDO CAMPOS",
"telefone": "(19) 988882001 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "LETICIA GUSSAKOV DE SORDI",
"vendedor": "KELIANE LOPES DE FRANÇA",
"telefone": "(19) 999147878 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MARCIO DE CARVALHO LEONARDO",
"vendedor": "ADENILTON JUNIOR",
"telefone": "(17) 997775484 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "STELA MARAFIOTE CIRELLI",
"vendedor": "ADENILTON JUNIOR",
"telefone": "(11) 984862929 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "RAQUEL CHEZINI PEREIRA",
"vendedor": "VITOR AUGUSTO JOEL",
"telefone": " (19) 988665204 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
}
],
"selectedPhoneColumn": "telefone"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"x-apidog-orders": [],
"x-apidog-ignore-properties": []
}
}
},
"headers": {},
"x-apidog-name": "Success",
"x-apidog-ordering": 0
}
},
"security": [
{
"bearer": []
}
],
"x-apidog-folder": "Shared/Utils",
"x-apidog-status": "released",
"x-run-in-apidog": "https://app.apidog.com/web/project/903051/apis/api-16494561-run"
}Respostas
200curl -X POST "https://api.falecomigo.ai/api/util/shots/validate-phones" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"data": [
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "GRACE APARECIDA RODRIGUES ALVES",
"vendedor": "ANDRE COELHO MICHELIN",
"telefone": "(11) 980661162 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "WILLIAM VICENTE DE MELO",
"vendedor": "MARCELO RANGEL",
"telefone": "(19) 992194465 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "JULIANA MARIA ARRUDA VIEIRA",
"vendedor": "JULIANE JOLECY NOVAES ANTUNES",
"telefone": "(19) 982088899 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "IVAN NIERO MIRANDA",
"vendedor": "JULIANE JOLECY NOVAES ANTUNES",
"telefone": "(19) 981182751 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "EDUARDO VIEIRA ALMEIDA",
"vendedor": "EUNICE HAYDEN",
"telefone": "(19) 991367063 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MARCIA REGINA GONÇALVES CASAREJOS",
"vendedor": "JUANELIZ WILLIAN SANTIAN",
"telefone": "(11) 972063335 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MICHELE CRISTINA CARDOSO BEZERRA",
"vendedor": "MATHEUS DE SOUZA",
"telefone": "(11) 981168164 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "JOSE TEODORO FILHO",
"vendedor": "MARCELO RANGEL",
"telefone": "(11) 995695609 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "PAULO FERNANDES DE OLIVEIRA",
"vendedor": "ANTONIO CARLOS PEREIRA DA SILVA",
"telefone": "(19) 993424898 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "RUI CARLOS PEDREIRA PASSOS",
"vendedor": "RODRIGO APARECIDO CAMPOS",
"telefone": "(19) 988882001 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "LETICIA GUSSAKOV DE SORDI",
"vendedor": "KELIANE LOPES DE FRANÇA",
"telefone": "(19) 999147878 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "MARCIO DE CARVALHO LEONARDO",
"vendedor": "ADENILTON JUNIOR",
"telefone": "(17) 997775484 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "STELA MARAFIOTE CIRELLI",
"vendedor": "ADENILTON JUNIOR",
"telefone": "(11) 984862929 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
},
{
"loja": "DAHRUJ HONDA CAMPINAS",
"cliente": "RAQUEL CHEZINI PEREIRA",
"vendedor": "VITOR AUGUSTO JOEL",
"telefone": " (19) 988665204 ",
"errors": [
{
"type": "client_cellphone",
"error": "cellphone not found"
},
{
"type": "shoter_cellphone",
"error": "Número de celular não encontrado"
}
]
}
],
"selectedPhoneColumn": "telefone"
}'200
{}Session
Buscar conversa ativa de um contato
Devolve a conversa em andamento do contato (contactId ou phone) no número integrationId, ou { session: null }.
gethttps://api.falecomigo.ai/api/sessions/active-for-dispatch
Parâmetros de consulta
integrationIdstringobrigatóriocontactIdstringobrigatóriophonestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"description": "Devolve a conversa em andamento do contato (`contactId` ou `phone`) no número `integrationId`, ou `{ session: null }`.",
"operationId": "SessionController_getActiveSessionForDispatch",
"parameters": [
{
"name": "integrationId",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "phone",
"required": true,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Buscar conversa ativa de um contato",
"tags": [
"Session",
"Mensagens"
]
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/sessions/active-for-dispatch?integrationId=...&contactId=...&phone=..." \ -H "Authorization: Bearer $FALECOMIGO_API_TOKEN"
Template
Variáveis de um modelo
Lista as variáveis que o modelo espera, para montar o disparo.
gethttps://api.falecomigo.ai/api/templates/{id}/variables
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"description": "Lista as variáveis que o modelo espera, para montar o disparo.",
"operationId": "TemplateController_getVariables",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Variáveis de um modelo",
"tags": [
"Template",
"Modelos"
]
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/templates/{id}/variables" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Contact
Buscar contato por id
gethttps://api.falecomigo.ai/api/contacts/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"operationId": "ContactController_getContactById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Buscar contato por id",
"tags": [
"Contact",
"Contatos"
]
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/contacts/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Contact
Atualizar contato
Devolve 409 se o telefone já pertence a outro contato. O dono do contato passa a ser o usuário do token.
puthttps://api.falecomigo.ai/api/contacts/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"description": "Devolve 409 se o telefone já pertence a outro contato. O dono do contato passa a ser o usuário do token.",
"operationId": "ContactController_updateContact",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactDto"
}
}
}
},
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Atualizar contato",
"tags": [
"Contact",
"Contatos"
]
}Respostas
200curl -X PUT "https://api.falecomigo.ai/api/contacts/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'Lead
Buscar lead pelo telefone
gethttps://api.falecomigo.ai/api/leads/by-phone/{phone}
Parâmetros de caminho
phonestringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"operationId": "LeadController_findByPhone",
"parameters": [
{
"name": "phone",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Buscar lead pelo telefone",
"tags": [
"Lead",
"Leads"
]
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/by-phone/{phone}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Lead
Buscar lead por id
gethttps://api.falecomigo.ai/api/leads/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"operationId": "LeadController_findOne",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Buscar lead por id",
"tags": [
"Lead",
"Leads"
]
}Respostas
200curl -X GET "https://api.falecomigo.ai/api/leads/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN"Lead
Atualizar lead / mover de etapa
Envie statusId para mover o lead de etapa no funil (e lossReasonId ao marcar como perdido).
patchhttps://api.falecomigo.ai/api/leads/{id}
Parâmetros de caminho
idstringobrigatórioAutenticação por token conforme as permissões da operação.
Estrutura completa, exemplos e respostas
{
"description": "Envie `statusId` para mover o lead de etapa no funil (e `lossReasonId` ao marcar como perdido).",
"operationId": "LeadController_update",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLeadDto"
}
}
}
},
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"apiToken": []
}
],
"summary": "Atualizar lead / mover de etapa",
"tags": [
"Lead",
"Leads"
]
}Respostas
200curl -X PATCH "https://api.falecomigo.ai/api/leads/{id}" \
-H "Authorization: Bearer $FALECOMIGO_API_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'