---
title: Default module
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: "@tarslib/widdershins v4.0.30"
---
# Default module
Collection completa da API de encurtamento de URLs com analytics
Base URLs:
* falecomigo.ai - prod: https://api.falecomigo.ai
Email: falecomigo.ai Web: falecomigo.ai
# Authentication
- HTTP Authentication, scheme: bearer
- HTTP Authentication, scheme: bearer
# Core/Auth
## GET Me
GET /api/auth/me
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Login
POST /api/auth/login
Utilize essa rota para obter o token de autenticação para utilizar nas rotas que exigem autenticação.
> Body Parameters
```json
{
"email": "email@test.com",
"password": "PASSWORD"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Verify token
GET /api/auth/verify
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Core/Access Level
## POST Invite new user
POST /access-management/organizations/{organization_id}/invite
> Body Parameters
```json
{
"email": "bewhalewell@gmail.com",
"firstName": "Sam",
"customerType": "PF",
"role": "admin"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|organization_id|path|string| yes |none|
|Authorization|header|string| yes |none|
|body|body|object| no |none|
|» email|body|string| yes |none|
|» firstName|body|string| yes |none|
|» customerType|body|string| yes |none|
|» role|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Core/Organization
## GET Stats
GET /organizations/stats
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|search|query|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Settings
GET /api/organization/settings
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|search|query|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Organization by ID
GET /api/organizations/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get All Customers
GET /api/customers/organization
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|search|query|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Communication/Chat/Campaign
## GET Campaign Shootings
GET /api/campaigns/{campaignId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|campaignId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Show Shooting
GET /api/shootings/{shootingId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|shootingId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List all
GET /campaigns
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Communication/Chat/Message
## POST Create
POST /api/messages
> Body Parameters
```json
{
"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
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» sessionId|body|string| yes |none|
|» type|body|string| yes |none|
|» direction|body|string| yes |none|
|» author|body|string| yes |none|
|» content|body|any| yes |none|
|»» *anonymous*|body|object| no |Text object|
|»»» text|body|string| yes |none|
|»» *anonymous*|body|object| no |Media object|
|»»» media|body|object| yes |none|
|»»»» url|body|string| no |none|
|»»»» fileKey|body|string| yes |none|
|»»»» caption|body|string| no |none|
|»»»» name|body|string| yes |none|
|»»»» original_name|body|string| yes |none|
|»»»» type|body|string| yes |none|
|»»»» extension|body|string| yes |none|
|»»»» mimeType|body|string| yes |none|
|»»»» transcription|body|string| no |none|
|» pauseSession|body|boolean| no |none|
|» status|body|string| no |none|
|» externalId|body|string| no |none|
|» sendExternalMessage|body|boolean| no |If true, it will send a message to the client. If false, it will only record the message in the database.|
|» customerId|body|string| no |none|
|» departmentId|body|string| no |none|
|» quotedMessageId|body|string| no |none|
|» metadata|body|object| no |none|
#### Enum
|Name|Value|
|---|---|
|» type|MEDIA|
|» type|TEXT|
|» type|RECORDING|
|» type|CHAT_COMMAND|
|» direction|IN|
|» direction|OUT|
|» author|CUSTOMER|
|» author|AGENT|
|» author|AGENT_PLATFORM|
|» author|AI|
|» author|BUSINESS|
|» author|SYSTEM|
|»»»» type|audio|
|»»»» type|image|
|»»»» type|video|
|»»»» type|document|
|» status|PENDING|
|» status|SENT|
|» status|DELIVERED|
|» status|READ|
|» status|FAILED|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Communication/Chat/Messaging/Quick Message
## GET List
GET /quick-messages
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
## POST Create
POST /quick-messages
> Body Parameters
```json
{
"name": "",
"color": "",
"type": "",
"content": {} //TextContent | MediaContent
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
## GET Show
GET /quick-messages/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
## PUT Update
PUT /quick-messages/{id}
> Body Parameters
```json
{
"name": "",
"color": "",
"type": "",
"content": {} //TextContent | MediaContent
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|body|body|object| no |none|
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
## DELETE Delete
DELETE /quick-messages/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
# Communication/Chat/Session
## GET List Contacts
GET /api/sessions/contacts
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|page|query|string| no |none|
|limit|query|string| no |none|
|search|query|string| no |none|
|integrationStatus|query|string| no |none|
|startedBy|query|string| no |none|
|integrationId|query|string| no |none|
|departmentId|query|string| no |none|
|attendantId|query|string| no |none|
|tagId|query|string| no |none|
|from|query|string| no |none|
|to|query|string| no |none|
|organizationId|query|string| no |none|
|status|query|string| no |none|
|responseFilter|query|string| no |none|
#### Enum
|Name|Value|
|---|---|
|responseFilter|all|
|responseFilter|responded|
|responseFilter|not_responded|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List By Contacts
GET /api/sessions/by-contact/{contactId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|contactId|path|string| yes |none|
|page|query|string| no |none|
|limit|query|string| no |none|
|status|query|string| no |none|
|from|query|string| no |none|
|to|query|string| no |none|
|integrationId|query|string| no |none|
|organizationId|query|string| no |none|
#### Enum
|Name|Value|
|---|---|
|status|OPEN|
|status|CLOSED|
|status|ON_HOLD|
|status|PAUSED|
|status|QUEUED|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Status
GET /api/sessions/status
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|businessPhone|query|string| yes |none|
|contactPhone|query|string| yes |none|
|status|query|string| yes |none|
> Response Examples
> 200 Response
```json
{
"hasSession": true,
"sessions": [
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» hasSession|boolean|true|none||none|
|» sessions|[object]|true|none||none|
|»» id|string|false|none||none|
|»» contactId|string|false|none||none|
|»» integrationId|string|false|none||none|
|»» organizationId|string|false|none||none|
|»» status|string|false|none||none|
|»» startedBy|string|false|none||none|
|»» createdAt|string|false|none||none|
|»» updatedAt|string|false|none||none|
## GET List
GET /api/sessions
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|query|string| no |none|
|page|query|string| yes |none|
|distinctByContact|query|string| yes |none|
|limit|query|string| yes |none|
|search|query|string| no |none|
|status|query|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create
POST /api/sessions
> Body Parameters
```json
{
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "OPEN",
"startedBy": "CUSTOMER"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» contactId|body|string| yes |none|
|» integrationId|body|string| yes |none|
|» organizationId|body|string| yes |none|
|» status|body|string| no |none|
|» startedBy|body|string| no |none|
#### Enum
|Name|Value|
|---|---|
|» status|OPEN|
|» status|PAUSED|
|» status|CLOSED|
|» startedBy|CUSTOMER|
|» startedBy|AGENT|
|» startedBy|BUSINESS|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Redirect URL (session balancer)
GET /api/sessions/redirect-url
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|text|query|string| no |none|
|organizationId|query|string| no |none|
|campaignName|query|string| no |none|
|utm_source|query|string| no |none|
|externalId|query|string| no |none|
> Response Examples
> 401 Response
```json
{
"statusCode": 0,
"timestamp": "string",
"path": "string",
"error": {
"message": "string",
"error": "string",
"statusCode": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **401**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» statusCode|integer|true|none||none|
|» timestamp|string|true|none||none|
|» path|string|true|none||none|
|» error|object|true|none||none|
|»» message|string|true|none||none|
|»» error|string|true|none||none|
|»» statusCode|integer|true|none||none|
## PUT Update
PUT /api/sessions/1a645855-1366-4803-90a9-e79c074b4966
> Body Parameters
```json
{
"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"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» contactId|body|string| no |none|
|» integrationId|body|string| no |none|
|» organizationId|body|string| no |none|
|» status|body|string| no |none|
|» externalId|body|string| no |none|
|» assignedAgentId|body|string| no |none|
|» statusReason|body|string| no |none|
|» endReason|body|string| no |none|
|» assignedCustomerId|body|string| no |none|
|» assignedDepartmentId|body|string| no |none|
#### Enum
|Name|Value|
|---|---|
|» status|CLOSED|
|» status|PAUSED|
|» status|OPEN|
|» status|QUEUED|
|» status|ON_HOLD|
|» statusReason|CLOSED_BY_INACTIVITY|
|» statusReason|CLOSED_BY_AGENT|
|» statusReason|CLOSED_BY_AI|
|» statusReason|CLOSED_BY_WINDOW_TIME|
> Response Examples
> 200 Response
```json
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string",
"contact": {
"id": "string",
"organizationId": "string",
"name": "string",
"email": null,
"phoneNumber": "string",
"externalId": null,
"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": null,
"walletId": null,
"createdAt": "string",
"updatedAt": "string"
},
"messages": [
{
"id": "string",
"sessionId": "string",
"externalId": "string",
"externalReferenceId": null,
"status": "string",
"type": "string",
"direction": "string",
"author": "string",
"content": {
"text": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
],
"tabulations": [
"string"
],
"ticket": null
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» id|string|true|none||none|
|» contactId|string|true|none||none|
|» integrationId|string|true|none||none|
|» organizationId|string|true|none||none|
|» status|string|true|none||none|
|» startedBy|string|true|none||none|
|» createdAt|string|true|none||none|
|» updatedAt|string|true|none||none|
|» contact|object|true|none||none|
|»» id|string|true|none||none|
|»» organizationId|string|true|none||none|
|»» name|string|true|none||none|
|»» email|null|true|none||none|
|»» phoneNumber|string|true|none||none|
|»» externalId|null|true|none||none|
|»» createdAt|string|true|none||none|
|»» updatedAt|string|true|none||none|
|» integration|object|true|none||none|
|»» id|string|true|none||none|
|»» name|string|true|none||none|
|»» customerId|string|true|none||none|
|»» organizationId|string|true|none||none|
|»» providerId|string|true|none||none|
|»» settings|object|true|none||none|
|»»» jid|string|true|none||none|
|»»» name|string|true|none||none|
|»»» qrcode|string|true|none||none|
|»»» connected|boolean|true|none||none|
|»»» instanceId|string|true|none||none|
|»»» integration|string|true|none||none|
|»»» phoneNumber|string|true|none||none|
|»»» phone_number|string|true|none||none|
|»»» instanceToken|string|true|none||none|
|»»» lastQrCodeUpdate|string|true|none||none|
|»» isActive|boolean|true|none||none|
|»» createdAt|string|true|none||none|
|»» updatedAt|string|true|none||none|
|» organization|object|true|none||none|
|»» id|string|true|none||none|
|»» ownerId|string|true|none||none|
|»» name|string|true|none||none|
|»» description|string|true|none||none|
|»» shortIdentifier|string|true|none||none|
|»» billingType|string|true|none||none|
|»» parentId|null|true|none||none|
|»» walletId|null|true|none||none|
|»» createdAt|string|true|none||none|
|»» updatedAt|string|true|none||none|
|» messages|[object]|true|none||none|
|»» id|string|false|none||none|
|»» sessionId|string|false|none||none|
|»» externalId|string|false|none||none|
|»» externalReferenceId|null|false|none||none|
|»» status|string|false|none||none|
|»» type|string|false|none||none|
|»» direction|string|false|none||none|
|»» author|string|false|none||none|
|»» content|object|false|none||none|
|»»» text|string|true|none||none|
|»» createdAt|string|false|none||none|
|»» updatedAt|string|false|none||none|
|» tabulations|[string]|true|none||none|
|» ticket|null|true|none||none|
## GET Integration with less sessions
GET /api/sessions/integration-with-less-sessions
> Response Examples
> 200 Response
```json
{
"hasSession": true,
"sessions": [
{
"id": "string",
"contactId": "string",
"integrationId": "string",
"organizationId": "string",
"status": "string",
"startedBy": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» hasSession|boolean|true|none||none|
|» sessions|[object]|true|none||none|
|»» id|string|false|none||none|
|»» contactId|string|false|none||none|
|»» integrationId|string|false|none||none|
|»» organizationId|string|false|none||none|
|»» status|string|false|none||none|
|»» startedBy|string|false|none||none|
|»» createdAt|string|false|none||none|
|»» updatedAt|string|false|none||none|
# Communication/Department
## GET List
GET /api/departments
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create
POST /api/departments
> Body Parameters
```json
{
"name": "string",
"slug": "string",
"description": "string",
"type": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» slug|body|string| yes |none|
|» description|body|string| no |none|
|» type|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update
PUT /api/departments
> Body Parameters
```json
{
"name": "string",
"slug": "string",
"description": "string",
"type": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| no |none|
|» slug|body|string| no |none|
|» description|body|string| no |none|
|» type|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Show
GET /api/departments/{departmendId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|departmendId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete
DELETE /api/departments/{departmendId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|departmendId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List Integration Departments
GET /api/departments/integrations/{integrationId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List Customer Departments
GET /api/departments/customers/{customerId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Customer Assign
POST /api/departments/customers/assign
> Body Parameters
```json
{
"departmendId": "string",
"customerId": "string",
"isDefault": true
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» departmendId|body|string| yes |none|
|» customerId|body|string| yes |none|
|» isDefault|body|boolean| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Integration Assign
POST /api/departments/integrations/assign
> Body Parameters
```json
{
"departmendId": "string",
"integrationId": "string",
"isDefault": true
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» departmendId|body|string| yes |none|
|» integrationId|body|string| yes |none|
|» isDefault|body|boolean| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Define Default Integration
PUT /api/departments/integrations/{integrationId}/default/{departmentId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|path|string| yes |none|
|departmentId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Define Default Customer
PUT /api/departments/customers/{customerId}/default/{departmentId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
|departmentId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Customer Unassign
DELETE /api/departments/customers/{departmentId}/{customerId}
> Body Parameters
```json
{}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|departmentId|path|string| yes |none|
|customerId|path|string| yes |none|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Integration Unassign
DELETE /api/departments/integrations/{departmentId}/{integrationId}
> Body Parameters
```json
{}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|departmentId|path|string| yes |none|
|integrationId|path|string| yes |none|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Communication/Dispatch/v2
## POST Create Dispatch
POST /api/v2/message-dispatch/create
> Body Parameters
> Template example:
Hello {{ customer_name }} you are {{ customer_age }} years old.
In this case, João will receive from the integration 79fdd7c3-a768-41df-85f8-9e2164c0f14e the text:
Hello João you are 37 years old.
And Tadeu will receive from the integration 79fdd7c3-a768-41df-85f8-9e2164c0f14e the text:
Hello Tadeu you are 29 years old.
```json
{
"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"
}
```
```json
{
"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"
}
```
```json
{
"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
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
```json
{
"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
}
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Authorization|header|string| yes |none|
|body|body|object| no |none|
|» contacts|body|[object]| yes |none|
|»» shooter|body|string| no |none|
|»» recipient|body|string| no |none|
|»» variables|body|object| no |none|
|»»» 1|body|string| yes |none|
|» campaignOrigin|body|string| yes |none|
|» campaignName|body|string| yes |none|
|» templateId|body|string| yes |none|
|» externalId|body|string| yes |none|
|» sheetFileUrl|body|string| yes |none|
|» campaignLabel|body|[string]| yes |none|
|» scheduledAt|body|string| yes |none|
|» attachment|body|object| yes |none|
|»» key|body|string| yes |none|
|»» name|body|string| yes |none|
|» settings|body|object| yes |none|
|»» smartBalancing|body|boolean| yes |none|
|»» smartReminder|body|boolean| yes |none|
|»» pausedSession|body|boolean| yes |none|
|»» contactsLabel|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Communication/Template
## POST Sync All Meta Integrations
POST /api/templates/meta/sync-all
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Sync Single Meta Integrations
POST /api/templates/meta/sync/{integrationId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create Meta
POST /api/templates/meta
> Body Parameters
```json
{
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» language|body|string| yes |none|
|» category|body|string| yes |none|
|» integrationIds|body|[string]| yes |none|
|» components|body|[object]| yes |none|
|»» text|body|string| yes |none|
|»» type|body|string| yes |none|
|»» format|body|string| no |none|
|»» example|body|object| no |none|
|»»» body_text|body|[array]| yes |none|
|»» buttons|body|[object]| no |none|
|»»» url|body|string| no |none|
|»»» text|body|string| no |none|
|»»» type|body|string| no |none|
|»»» example|body|[string]| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List
GET /api/templates
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create
POST /api/templates
> Body Parameters
```json
{
"name": "template teste",
"content": "Descrição detalhada do funcionamento esperado do template"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| yes |none|
|» content|body|string| yes |none|
|» category|body|string| yes |none|
|» type|body|string| yes |none|
|» variant|body|string| yes |none|
|» isControl|body|boolean| yes |none|
|» tags|body|[string]| yes |none|
|» language|body|string| yes |none|
|» integrationIds|body|[string]| yes |none|
|» components|body|[object]| yes |none|
|»» type|body|string| yes |none|
|»» format|body|string| no |none|
|»» text|body|string| no |none|
|»» example|body|object| no |none|
|»»» body_text|body|[array]| yes |none|
|»» buttons|body|[object]| no |none|
|»»» type|body|string| yes |none|
|»»» text|body|string| yes |none|
|»»» url|body|string| no |URL com {{1}} para variável dinâmica|
|»»» phone_number|body|string| no |none|
|»»» example|body|[string]| no |Valor de exemplo para a variável dinâmica da URL|
#### Enum
|Name|Value|
|---|---|
|» type|CUSTOM|
|» type|META|
|» type|EMAIL|
|»»» type|URL|
|»»» type|PHONE_NUMBER|
|»»» type|QUICK_REPLY|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Show
GET /api/templates/{templateId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|templateId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update
PUT /api/templates/{templateId}
> Body Parameters
```json
{
"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": {}
}
]
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|templateId|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| no |none|
|» description|body|string| no |none|
|» content|body|string| no |none|
|» category|body|string| no |none|
|» type|body|string| no |none|
|» variant|body|string| no |none|
|» isControl|body|boolean| no |none|
|» tags|body|[string]| no |none|
|» language|body|string| no |none|
|» integrationIds|body|[string]| no |none|
|» components|body|[object]| no |none|
|»» type|body|string| yes |none|
|»» format|body|string| no |none|
|»» text|body|string| no |none|
|»» example|body|object| no |none|
|»»» body_text|body|[array]| yes |none|
|»» buttons|body|[object]| no |none|
|»»» type|body|string| yes |none|
|»»» text|body|string| yes |none|
|»»» url|body|string| no |URL com {{1}} para variável dinâmica|
|»»» phone_number|body|string| no |none|
|»»» example|body|[string]| no |Valor de exemplo para a variável dinâmica da URL|
#### Enum
|Name|Value|
|---|---|
|» type|CUSTOM|
|» type|META|
|» type|EMAIL|
|»»» type|URL|
|»»» type|PHONE_NUMBER|
|»»» type|QUICK_REPLY|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm
## POST Smart Contact
POST /smart-contact
> Body Parameters
```json
{
"q": "clinica-medica em São Paulo - SP - Vila Arriete",
"location": "Brazil",
"gl": "br",
"hl": "pt-br",
"results": 50
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Authorization|header|string| yes |none|
|body|body|object| no |none|
|» q|body|string| yes |none|
|» location|body|string| yes |none|
|» gl|body|string| yes |none|
|» hl|body|string| yes |none|
|» results|body|integer| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create Contact
POST /api/contacts
> Body Parameters
```json
{
"name": "string",
"email": "string",
"phoneNumber": "string",
"externalId": "string",
"bypassBots": true,
"origin": "WHATSAPP_BUSINESS"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| no |name|
|» email|body|string| no |none|
|» phoneNumber|body|string| no |none|
|» externalId|body|string| no |none|
|» bypassBots|body|boolean| no |none|
|» origin|body|string| no |none|
#### Enum
|Name|Value|
|---|---|
|» origin|WHATSAPP_BUSINESS|
|» origin|WHATSAPP_META|
|» origin|TELEGRAM|
|» origin|INSTAGRAM|
|» origin|TELEPHONE|
|» origin|EMAIL|
|» origin|API|
|» origin|LEAD|
|» origin|META_LEAD|
|» origin|WEB_CHAT|
|» origin|WEB_FORM|
|» origin|LANDING_PAGE|
|» origin|FACEBOOK|
|» origin|MESSENGER|
|» origin|SMS|
|» origin|TIKTOK|
|» origin|LINKEDIN|
|» origin|X_TWITTER|
|» origin|THREADS|
|» origin|ECOMMERCE|
|» origin|SUPPORT_TICKET|
|» origin|HELP_DESK|
|» origin|CHATBOT_FALLBACK|
|» origin|N8N|
|» origin|INTEGRATION_WEBHOOK|
|» origin|IN_PERSON|
|» origin|EVENT|
|» origin|REFERRAL|
|» origin|MANUAL_ENTRY|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List
GET /api/contacts
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|query|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update Contact
PUT /api/contacts/{contactId}
> Body Parameters
```json
{
"name": "string",
"email": "string",
"phoneNumber": "string",
"bypassBots": true,
"origin": "WHATSAPP_BUSINESS"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|contactId|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| no |name|
|» email|body|string| no |none|
|» phoneNumber|body|string| no |none|
|» bypassBots|body|boolean| no |none|
|» origin|body|string| no |none|
#### Enum
|Name|Value|
|---|---|
|» origin|WHATSAPP_BUSINESS|
|» origin|WHATSAPP_META|
|» origin|TELEGRAM|
|» origin|INSTAGRAM|
|» origin|TELEPHONE|
|» origin|EMAIL|
|» origin|API|
|» origin|LEAD|
|» origin|META_LEAD|
|» origin|WEB_CHAT|
|» origin|WEB_FORM|
|» origin|LANDING_PAGE|
|» origin|FACEBOOK|
|» origin|MESSENGER|
|» origin|SMS|
|» origin|TIKTOK|
|» origin|LINKEDIN|
|» origin|X_TWITTER|
|» origin|THREADS|
|» origin|ECOMMERCE|
|» origin|SUPPORT_TICKET|
|» origin|HELP_DESK|
|» origin|CHATBOT_FALLBACK|
|» origin|N8N|
|» origin|INTEGRATION_WEBHOOK|
|» origin|IN_PERSON|
|» origin|EVENT|
|» origin|REFERRAL|
|» origin|MANUAL_ENTRY|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get contacts by integration id
GET /api/contacts/integration/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Evolution
GET /api/contacts/evolution
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integrationId|query|string| no |none|
> Response Examples
> 200 Response
```json
{
"data": [
{
"id": "string",
"name": "string",
"phoneNumber": "string"
}
],
"pagination": {
"total_data": 0,
"total_pages": 0,
"current_page": 0,
"limit": 0
}
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» data|[object]|true|none||none|
|»» id|string|true|none||none|
|»» name|string|true|none||none|
|»» phoneNumber|string|true|none||none|
|» pagination|object|true|none||none|
|»» total_data|integer|true|none||none|
|»» total_pages|integer|true|none||none|
|»» current_page|integer|true|none||none|
|»» limit|integer|true|none||none|
# Crm/Attribute
## POST Create an attribute
POST /api/attribute
> Body Parameters
```json
{
"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"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| yes |none|
|» type|body|string| yes |none|
|» organizationId|body|string| yes |none|
#### Enum
|Name|Value|
|---|---|
|» type|TEXT|
|» type|DATE|
|» type|DATETIME|
|» type|INTEGER|
|» type|FLOAT|
|» type|DOCUMENT|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get all attribute for the active customer organization
GET /api/attribute
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Contact/Attribute
## GET Get all
GET /api/contact-attribute
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create an attribute for a contact
POST /api/contact-attribute
> Body Parameters
```json
{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"attributeId": "93b99469-925c-4cc9-8782-7d7c9d409ea0",
"value": "10"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» contactId|body|string| yes |none|
|» attributeId|body|string| yes |none|
|» value|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get all attributes for a contact
GET /api/contact-attribute/contact/{contactId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|contactId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update a contact attribute
PUT /api/contact-attribute/{id}
> Body Parameters
```json
{
"value": "200"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|body|body|object| no |none|
|» value|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete a contact attribute
DELETE /api/contact-attribute/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Contact/Tabulation
## POST Create ContactTabulation
POST /api/contact-tabulation
> Body Parameters
```json
{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"tabulationId": "b0d192b1-3822-40e0-9c74-e8cbff4b261d"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» contactId|body|string| yes |none|
|» tabulationId|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Change tabulation for a contact
PATCH /api/contact-tabulation
> Body Parameters
```json
{
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"currentTabulationId": "c92963a5-8f01-4e27-9a60-a3fee7ca1a5c",
"newTabulationId": "e596a4ab-a149-4a95-a07c-9daad0ec0094"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» contactId|body|string| yes |none|
|» currentTabulationId|body|string| yes |none|
|» newTabulationId|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete ContactTabulation
DELETE /api/contact-tabulation/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get all tabulations for a contact
GET /api/contact-tabulation/{contactId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|contactId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Contact/Observation
## GET Get all observation for a contact
GET /api/contact-observation/{contactId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|contactId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create observation for a contact
POST /api/contact-observation
> Body Parameters
```json
{
"text": "Observação bem legal pro paulinho!!",
"isPinned": false,
"contactId": "fafc6662-37b4-46a8-a35a-25abd986f5c6",
"createdBy": "f78819a0-d534-418b-bec2-f282ae49818f"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» text|body|string| yes |none|
|» isPinned|body|boolean| no |none|
|» contactId|body|string| yes |none|
|» createdBy|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update an observation
PATCH /api/contact-observation/{id}
> Body Parameters
```json
{
"isPinned": true
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|body|body|object| no |none|
|» text|body|string| no |none|
|» isPinned|body|boolean| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete an observation
DELETE /api/contact-observation/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Contact/Profile
## GET Get Profile
GET /api/profile/{customerId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update Profile
PUT /api/profile/{customerId}
> Body Parameters
```
firstName: Nome Atualizado
lastName: Sobrenome Atualizado
phone: "+5511987654321"
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
|Authorization|header|string| yes |none|
|body|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Upload Profile Picture
POST /api/profile/{customerId}/profile-picture
> Body Parameters
```yaml
file: string
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
|Authorization|header|string| yes |none|
|body|body|object| no |none|
|» file|body|string(binary)| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Organizations
GET /api/profile/{customerId}/organizations
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|path|string| yes |none|
|Authorization|header|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update Organization
PUT /api/profile/organizations/{organizationId}
> Body Parameters
```
name: Nome Atualizado
description: Descrição atualizada
domain: novodominio.com.br
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|organizationId|path|string| yes |none|
|Authorization|header|string| yes |none|
|body|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update Billing Info
PUT /api/profile/organizations/{organizationId}/billing
> Body Parameters
```
billingAddress: Rua Exemplo, 123
city: São Paulo
state: SP
zipCode: 01234-567
paymentMethod: creditCard
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|organizationId|path|string| yes |none|
|Authorization|header|string| yes |none|
|body|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Kanban
## POST Create kanban board
POST /api/kanban
> Body Parameters
```json
{
"name": "Lead novo"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get kanban boards
GET /api/kanban
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create kanban board column
POST /api/kanban/{boardId}
> Body Parameters
```json
{
"name": "Lead novo"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|boardId|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» tabulationId|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get kanban board columns
GET /api/kanban/{boardId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|boardId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Change board name
PATCH /api/kanban/{boardId}
> Body Parameters
```json
{
"name": "Novo funil"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|boardId|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete kanban board
DELETE /api/kanban/{boardId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|boardId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Leads/Leads
## POST Create Lead
POST /api/leads
> Body Parameters
```json
{"name":"Acme Corp","email":"contact@acme.com","company":"Acme","status":"NEW","temperature":"WARM"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» email|body|string| no |none|
|» phone|body|string| yes |none|
|» company|body|string| no |none|
|» website|body|string| no |none|
|» avatar|body|string| no |none|
|» position|body|string| no |none|
|» source|body|string| no |none|
|» contactOriginConfigId|body|string| no |none|
|» status|body|string| no |none|
|» statusId|body|string| no |none|
|» score|body|integer| no |none|
|» temperature|body|string| no |none|
|» estimatedValue|body|integer| no |none|
|» notes|body|string| no |none|
|» isIcp|body|boolean| no |none|
|» ownerId|body|string| no |none|
|» metadata|body|object| no |none|
|»» campaign|body|string| yes |none|
|»» region|body|string| yes |none|
|»» industry|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List Leads
GET /api/leads
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|page|query|string| yes |none|
|limit|query|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Statistics
GET /api/leads/statistics
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Lead
GET /api/leads/{leadId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Lead
PATCH /api/leads/{leadId}
> Body Parameters
```json
{"status":"CONTACTED","temperature":"HOT"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» status|body|string| yes |none|
|» temperature|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Lead
DELETE /api/leads/{leadId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Contacts
GET /api/leads/{leadId}/contacts
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Add Contact
POST /api/leads/{leadId}/contacts
> Body Parameters
```json
{"contactId":"{{contactId}}","role":"Decision Maker","isPrimary":true}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» contactId|body|string| yes |none|
|» role|body|string| yes |none|
|» isPrimary|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Contact
PATCH /api/leads/{leadId}/contacts/{contactId}
> Body Parameters
```json
{"role":"Technical","isPrimary":false}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|contactId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» role|body|string| yes |none|
|» isPrimary|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Remove Contact
DELETE /api/leads/{leadId}/contacts/{contactId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|contactId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Set Primary Contact
PATCH /api/leads/{leadId}/contacts/{contactId}/set-primary
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|contactId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Sessions
GET /api/leads/{leadId}/sessions
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|limit|query|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Leads/Custom Fields
## GET Get Categories
GET /api/custom-fields/categories
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create Category
POST /api/custom-fields/categories
> Body Parameters
```json
{"name":"Company Info","icon":"building"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» icon|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Category
PATCH /api/custom-fields/categories/{categoryId}
> Body Parameters
```json
{"name":"Updated Name"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|categoryId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Category
DELETE /api/custom-fields/categories/{categoryId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|categoryId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Reorder Categories
POST /api/custom-fields/categories/reorder
> Body Parameters
```json
{"categoryIds":["id1","id2"]}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» categoryIds|body|[string]| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create Dropdown Field
POST /api/custom-fields/fields
> Body Parameters
```json
{"categoryId":"{{categoryId}}","name":"Size","type":"dropdown","options":[{"label":"Small","value":"small"},{"label":"Large","value":"large"}]}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» categoryId|body|string| yes |none|
|» name|body|string| yes |none|
|» type|body|string| yes |none|
|» options|body|[object]| yes |none|
|»» label|body|string| yes |none|
|»» value|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Field
PATCH /api/custom-fields/fields/{fieldId}
> Body Parameters
```json
{"name":"Updated","required":true}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|fieldId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» required|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Field
DELETE /api/custom-fields/fields/{fieldId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|fieldId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Reorder Fields
POST /api/custom-fields/fields/reorder
> Body Parameters
```json
{"categoryId":"{{categoryId}}","fieldIds":["id1","id2"]}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» categoryId|body|string| yes |none|
|» fieldIds|body|[string]| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Lead Values
GET /api/custom-fields/leads/{leadId}/values
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Value
PATCH /api/custom-fields/leads/{leadId}/values
> Body Parameters
```json
{"fieldId":"{{fieldId}}","value":"test"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» fieldId|body|string| yes |none|
|» value|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Bulk Update Values
POST /api/custom-fields/leads/{leadId}/values/bulk
> Body Parameters
```json
{"values":[{"fieldId":"id1","value":"v1"}]}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» values|body|[object]| yes |none|
|»» fieldId|body|string| no |none|
|»» value|body|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Leads/Opportunities
## POST Create Opportunity
POST /api/opportunities
> Body Parameters
```json
{"leadId":"{{leadId}}","name":"Deal","value":50000,"stage":"Proposal","probability":70}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» leadId|body|string| yes |none|
|» name|body|string| yes |none|
|» value|body|integer| yes |none|
|» stage|body|string| yes |none|
|» probability|body|integer| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get by Lead
GET /api/opportunities/lead/{leadId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Statistics
GET /api/opportunities/statistics
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Opportunity
GET /api/opportunities/{opportunityId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|opportunityId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Mark as Won
PATCH /api/opportunities/{opportunityId}
> Body Parameters
```json
{"status":"WON"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|opportunityId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» status|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Opportunity
DELETE /api/opportunities/{opportunityId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|opportunityId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Leads/Tasks
## POST Create Task
POST /api/tasks
> Body Parameters
```json
{"leadId":"{{leadId}}","title":"Follow up","dueDate":"2025-02-01","priority":"HIGH"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» leadId|body|string| yes |none|
|» title|body|string| yes |none|
|» dueDate|body|string| yes |none|
|» priority|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get My Tasks
GET /api/tasks/my
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Overdue Tasks
GET /api/tasks/overdue
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get by Lead
GET /api/tasks/lead/{leadId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Task
GET /api/tasks/{taskId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|taskId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Task
PATCH /api/tasks/{taskId}
> Body Parameters
```json
{"title":"Updated","priority":"URGENT"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|taskId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» title|body|string| yes |none|
|» priority|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Task
DELETE /api/tasks/{taskId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|taskId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Toggle Complete
PATCH /api/tasks/{taskId}/toggle
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|taskId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Leads/Addresses
## POST Create Address
POST /api/addresses
> Body Parameters
```json
{"leadId":"{{leadId}}","street":"Av Paulista","number":"1000","city":"São Paulo","state":"SP","zipCode":"01310-100","isPrimary":true}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» leadId|body|string| yes |none|
|» street|body|string| yes |none|
|» number|body|string| yes |none|
|» city|body|string| yes |none|
|» state|body|string| yes |none|
|» zipCode|body|string| yes |none|
|» isPrimary|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get by Lead
GET /api/addresses/lead/{leadId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|leadId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Address
GET /api/addresses/{addressId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|addressId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Update Address
PATCH /api/addresses/{addressId}
> Body Parameters
```json
{"number":"2000","complement":"Sala 101"}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|addressId|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» number|body|string| yes |none|
|» complement|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Address
DELETE /api/addresses/{addressId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|addressId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Set Primary
PATCH /api/addresses/{addressId}/set-primary
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|addressId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Crm/Statuses
## POST Create a new status
POST /api/statuses
> Body Parameters
```json
null
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|any| yes |none|
> Response Examples
> 201 Response
```json
null
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Status created|Inline|
### Responses Data Schema
## GET Get all statuses
GET /api/statuses
Optionally filtered by category and isActive
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|category|query|any| no |none|
|isActive|query|boolean| no |none|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|List of statuses|Inline|
### Responses Data Schema
## GET Get statuses by category
GET /api/statuses/category/{category}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|category|path|any| yes |none|
|onlyActive|query|boolean| no |If true (default), only active statuses are returned|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|List of statuses by category|Inline|
### Responses Data Schema
## GET Get default status for a category
GET /api/statuses/category/{category}/default
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|category|path|any| yes |none|
> Response Examples
> 200 Response
```json
null
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default status for category|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Default status not found|None|
### Responses Data Schema
## POST Initialize default statuses for organization
POST /api/statuses/initialize
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|category|query|any| no |Optional category to initialize. If omitted, all categories may be initialized.|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default statuses initialized|Inline|
### Responses Data Schema
## PUT Reorder statuses
PUT /api/statuses/reorder
> Body Parameters
```json
null
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|any| yes |none|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Statuses reordered|Inline|
### Responses Data Schema
## GET Get a single status
GET /api/statuses/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string(uuid)| yes |none|
> Response Examples
> 200 Response
```json
null
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Status|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Status not found|None|
### Responses Data Schema
## PUT Update a status
PUT /api/statuses/{id}
> Body Parameters
```json
null
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string(uuid)| yes |none|
|body|body|any| yes |none|
> Response Examples
> 200 Response
```json
null
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Updated status|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Status not found|None|
### Responses Data Schema
## DELETE Delete a status
DELETE /api/statuses/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string(uuid)| yes |none|
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Status deleted|None|
# Features/Dashboard/v1
## GET Performance
GET /api/dashboard/performance
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|query|string| yes |The customer id.|
|interval|query|string| yes |The time interval to perform the query.|
#### Enum
|Name|Value|
|---|---|
|interval|Yesterday|
|interval|Today|
|interval|Last7Days|
|interval|Last30Days|
|interval|Last90Days|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Grouped Performance
GET /api/dashboard/performance/grouped
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|query|string| no |The customer id.|
|interval|query|string| yes |The time interval to perform the query.|
#### Enum
|Name|Value|
|---|---|
|interval|Yesterday|
|interval|Today|
|interval|Last7Days|
|interval|Last30Days|
|interval|Last90Days|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Phone Call
GET /api/dashboard/phone-call
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|query|string| yes |The customer id.|
|interval|query|string| yes |The time interval to perform the query.|
#### Enum
|Name|Value|
|---|---|
|interval|Yesterday|
|interval|Today|
|interval|Last7Days|
|interval|Last30Days|
|interval|Last90Days|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Conversation
GET /api/dashboard/conversation
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|query|string| yes |The customer id.|
|interval|query|string| yes |The time interval to perform the query.|
#### Enum
|Name|Value|
|---|---|
|interval|Yesterday|
|interval|Today|
|interval|Last7Days|
|interval|Last30Days|
|interval|Last90Days|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Grouped Conversation
GET /api/dashboard/conversation/grouped
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|customerId|query|string| yes |The customer id.|
|interval|query|string| yes |none|
#### Enum
|Name|Value|
|---|---|
|interval|Yesterday|
|interval|Today|
|interval|Last7Days|
|interval|Last30Days|
|interval|Last90Days|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/Dashboard/v2
## GET Team Metrics
GET /api/dashboard-v2/team
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/Label
## GET List
GET /api/labels
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create
POST /api/labels
> Body Parameters
```json
{
"name": "teste",
"category": "DASHBOARD",
"isActive": true
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» category|body|string| yes |group|
|» name|body|string| yes |name|
|» isActive|body|boolean| no |none|
#### Enum
|Name|Value|
|---|---|
|» category|DASHBOARD|
|» category|CAMPAIGN|
|» category|INTEGRATION|
|» category|CONVERSATION|
|» category|OTHER|
> Response Examples
> 200 Response
```json
[
"string"
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Show
GET /api/labels/{labelId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|labelId|path|string| yes |none|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update
PUT /api/labels/{labelId}
> Body Parameters
```json
{
"name": "teste2",
"category": "DASHBOARD",
"isActive": true
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|labelId|path|string| yes |none|
|body|body|object| no |none|
|» category|body|string| yes |group|
|» name|body|string| yes |name|
|» isActive|body|boolean| no |isActive|
#### Enum
|Name|Value|
|---|---|
|» category|DASHBOARD|
|» category|CAMPAIGN|
|» category|INTEGRATION|
|» category|CONVERSATION|
|» category|OTHER|
> Response Examples
> 200 Response
```json
[
"string"
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete
DELETE /api/labels/{labelId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|labelId|path|string| yes |none|
> Response Examples
> 200 Response
```json
[
"string"
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List by Category
GET /api/labels/category/{category}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|category|path|string| yes |none|
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Stats
GET /api/labels/stats
> Response Examples
> 200 Response
```json
[
null
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Toggle active status
PATCH /api/labels/{labelId}/toggle
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|labelId|path|string| yes |none|
> Response Examples
> 200 Response
```json
[
"string"
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/Tabulation
## GET List
GET /api/tabulations
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create
POST /api/tabulations
> Body Parameters
```json
{
"name": "tabulação teste",
"description": "Descrição detalhada do funcionamento esperado da tabulação",
"backgroundColor": "#fff",
"autoTabulation": false
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| yes |none|
|» backgroundColor|body|string| yes |none|
|» autoTabulation|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Show
GET /api/tabulations/{tabulationId}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|tabulationId|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update
PUT /api/tabulations/{tabulationId}
> Body Parameters
```json
{
"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": {}
}
]
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|tabulationId|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| yes |none|
|» backgroundColor|body|string| yes |none|
|» autoTabulation|body|boolean| yes |none|
|» integration_ids|body|[string]| yes |none|
|» tabulation_settings|body|[object]| yes |none|
|»» tabulationId|body|string| no |none|
|»» name|body|string| no |none|
|»» type|body|string| no |none|
|»» settings|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Associate
PATCH /api/tabulation/associate
> Body Parameters
```json
{
"tabulationId": "",
"contacId": "",
"sessionId": ""
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PATCH Disassociate
PATCH /api/tabulation/disassociate
> Body Parameters
```json
{
"tabulationId": "",
"sessionId": ""
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/URL Shortener/🔐 Admin - CRUD
## POST Create Short Link - Campaign
POST /api/short-links
Link associado a uma campanha de marketing.
> Body Parameters
```json
{
"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"]
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» originalUrl|body|string| yes |none|
|» customAlias|body|string| yes |none|
|» campaignId|body|string| yes |none|
|» maxClicks|body|integer| yes |none|
|» expiresAt|body|string| yes |none|
|» utm|body|object| yes |none|
|»» source|body|string| yes |none|
|»» medium|body|string| yes |none|
|»» campaign|body|string| yes |none|
|» tags|body|[string]| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List Short Links - Filtered
GET /api/short-links
Lista short links com filtros aplicados.
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|page|query|string| yes |none|
|pageSize|query|string| yes |none|
|isActive|query|string| yes |Apenas links ativos|
|tags|query|string| yes |Filtrar por tags (separadas por vírgula)|
|campaignId|query|string| no |Filtrar por campanha (opcional)|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Get Short Link by ID
GET /api/short-links/shortLinkId
Busca detalhes completos de um short link por ID.
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update Short Link
PUT /api/short-links/shortLinkId
Atualiza configurações de um short link existente.
> Body Parameters
```json
{
"isActive": true,
"maxClicks": 2000,
"expiresAt": "2026-12-31T23:59:59.000Z",
"tags": ["marketing", "promocao", "updated"],
"metadata": {
"lastUpdate": "2025-01-09",
"updatedBy": "Admin"
}
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» isActive|body|boolean| yes |none|
|» maxClicks|body|integer| yes |none|
|» expiresAt|body|string| yes |none|
|» tags|body|[string]| yes |none|
|» metadata|body|object| yes |none|
|»» lastUpdate|body|string| yes |none|
|»» updatedBy|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete Short Link
DELETE /api/short-links/shortLinkId
Remove permanentemente um short link.
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/URL Shortener/🔓 Public Routes
## GET Redirect - With Password
GET /abc123
Redireciona após validar senha do link protegido.
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|password|query|string| yes |Senha para links protegidos|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Verify Password
POST /abc123/verify
Verifica senha de link protegido sem fazer o redirect.
> Body Parameters
```json
{
"password": "senha123"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» password|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Features/URL Shortener/📊 Analytics
## GET Get Stats - Last 7 Days
GET /api/short-links/shortLinkId/stats
Estatísticas dos últimos 7 dias.
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|startDate|query|string| yes |none|
|endDate|query|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Integration
## GET List integrations
GET /api/integrations
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|connected|query|string| yes |none|
|search|query|string| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create integration
POST /api/integrations
> Body Parameters
```json
{
"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
}
}
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» customerId|body|string| yes |none|
|» organizationId|body|string| yes |none|
|» providerId|body|string| yes |none|
|» settings|body|object| yes |none|
|»» name|body|string| yes |none|
|»» phoneNumber|body|string| yes |none|
|»» integration|body|string| yes |none|
|»» additional_settings|body|object| yes |none|
|»»» rejectCall|body|boolean| yes |none|
|»»» msgCall|body|boolean| yes |none|
|»»» groupsIgnore|body|boolean| yes |none|
|»»» alwaysOnline|body|boolean| yes |none|
|»»» readMessages|body|boolean| yes |none|
|»»» readStatus|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET List integration
GET /api/integrations/{integration_id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## PUT Update integration
PUT /api/integrations/{integration_id}
> Body Parameters
```json
{
"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
}
}
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» settings|body|object| yes |none|
|»» name|body|string| yes |none|
|»» phoneNumber|body|string| yes |none|
|»» integration|body|string| yes |none|
|»» additional_settings|body|object| yes |none|
|»»» rejectCall|body|boolean| yes |none|
|»»» msgCall|body|boolean| yes |none|
|»»» groupsIgnore|body|boolean| yes |none|
|»»» alwaysOnline|body|boolean| yes |none|
|»»» readMessages|body|boolean| yes |none|
|»»» readStatus|body|boolean| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## DELETE Delete integration
DELETE /api/integrations/{integration_id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Connect integration
POST /api/integrations/{integration_id}/connect
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Connect evo integration
POST /api/integrations/connect
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Sign QRCode
POST /api/integrations/{integration_id}/sign-qr
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Disconnect integration
POST /api/integrations/{integration_id}/disconnect
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|integration_id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Integration/Connection
## GET Get all connections
GET /api/connection
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Create a connection
POST /api/connection
> Body Parameters
```json
{
"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
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| yes |none|
|» icon|body|string| yes |none|
|» type|body|string| yes |none|
|» connectionKey|body|string| yes |none|
|» url|body|string| yes |none|
|» scope|body|string| no |none|
|» fields|body|object| no |none|
|» enabled|body|boolean| yes |none|
#### Enum
|Name|Value|
|---|---|
|» type|OAUTH|
|» type|API_KEY|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## GET Find one connection
GET /api/connection/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Integration/Oauth
## POST Instagram
POST /api/oauth/instagram/callback
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST WhatsApp
POST /api/oauth/whatsapp/callback
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Shared/Utils
## POST Process Dispatch File
POST /api/util/shots/file-content
> Body Parameters
```yaml
fileUrl: https://storage.falecomigo.ai/dispatch-files-upload/uploads/1741959315854-Larissa%2014-03.xlsx
fileType: XLSX
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» fileUrl|body|string| yes |none|
|» fileType|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
## POST Validate Phones
POST /api/util/shots/validate-phones
> Body Parameters
```json
{
"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"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» data|body|[object]| yes |none|
|»» loja|body|string| yes |none|
|»» cliente|body|string| yes |none|
|»» vendedor|body|string| yes |none|
|»» telefone|body|string| yes |none|
|»» errors|body|[object]| yes |none|
|»»» type|body|string| yes |none|
|»»» error|body|string| yes |none|
|» selectedPhoneColumn|body|string| yes |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
### Responses Data Schema
# Data Schema