Olá {{first_name}}
Bem-vindo(a) à CloudWhats.
", "textBody": "Olá! Bem-vindo(a) à CloudWhats.", "audienceType": "manual", "recipients": [ { "email": "cliente@example.com", "name": "Cliente Exemplo", "source": "manual", "variables": { "first_name": "Cliente" } } ], "action": "draft" } }, "exemplo2": { "summary": "Create Email Campaign (Scheduled)", "value": { "name": "Newsletter semanal", "channelAccountId": "{{channelAccountId}}", "topicId": null, "segmentId": null, "contentMode": "custom", "subject": "Novidades da semana", "previewText": "Resumo rápido das atualizações", "fromName": "Time CloudWhats", "htmlBody": "Confira as novidades da semana.
", "textBody": "Confira as novidades da semana.", "audienceType": "manual", "recipients": [ { "email": "cliente@example.com", "name": "Cliente Exemplo", "source": "manual" } ], "action": "schedule", "scheduledAt": "{{scheduledDate}}" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-campaigns/{id}": { "get": { "tags": [ "Disparos" ], "summary": "Consultar campanhas de e-mail", "description": "Retorna o detalhe completo da campanha, incluindo conta de envio, destinatários e eventos recentes.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-campaigns-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "eventsTake", "in": "query", "required": false, "schema": { "type": "integer", "default": 25 }, "description": "Valor opcional de events take." }, { "name": "recipientsTake", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Valor opcional de recipients take." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "patch": { "tags": [ "Disparos" ], "summary": "Atualizar campanhas de e-mail", "description": "Reagenda a campanha para uma nova data futura.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "patch-email-campaigns-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "scheduledAt": { "type": "string" } }, "required": [ "scheduledAt" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Reschedule Email Campaign", "value": { "scheduledAt": "{{scheduledDate}}" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-campaigns/{id}/cancel": { "post": { "tags": [ "Disparos" ], "summary": "Cancelar campanhas de e-mail", "description": "Cancela a campanha no estado atual e sincroniza o retorno disponível.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-email-campaigns-id-cancel", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-campaigns/{id}/logs": { "get": { "tags": [ "Disparos" ], "summary": "Listar registros", "description": "Lista destinatários e eventos da campanha com paginação independente para cada grupo.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-campaigns-id-logs", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "eventsPage", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Valor opcional de events page." }, { "name": "eventsPageSize", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Valor opcional de events page size." }, { "name": "recipientQuery", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de recipient query." }, { "name": "recipientStatus", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de recipient status." }, { "name": "recipientsPage", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Valor opcional de recipients page." }, { "name": "recipientsPageSize", "in": "query", "required": false, "schema": { "type": "integer", "default": 50 }, "description": "Valor opcional de recipients page size." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" } }, "/api/email-campaigns/{id}/send": { "post": { "tags": [ "Disparos" ], "summary": "Enviar campanhas de e-mail", "description": "Dispara imediatamente uma campanha elegível para envio.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-email-campaigns-id-send", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-marketing/segments": { "get": { "tags": [ "Disparos" ], "summary": "Listar segments", "description": "Lista os segmentos disponíveis no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-marketing-segments", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "includeArchived", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de include archived." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "post": { "tags": [ "Disparos" ], "summary": "Criar ou executar segments", "description": "Cria um segmento de marketing por e-mail. O exemplo usa `filters: []` para evitar dependência de operadores específicos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-email-marketing-segments", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string", "default": "" }, "value2": { "type": "string" } }, "required": [ "id", "field", "operator" ], "additionalProperties": false } }, "channelAccountId": {}, "syncNow": { "type": "boolean", "default": true } }, "required": [ "name", "description", "filters", "channelAccountId" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Email Marketing Segment", "value": { "name": "Clientes com e-mail válido", "description": "Segmento criado via API", "filters": [], "channelAccountId": "{{channelAccountId}}", "syncNow": true } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-marketing/segments/{id}": { "get": { "tags": [ "Disparos" ], "summary": "Consultar segments", "description": "Retorna o detalhe de um segmento de marketing por e-mail no escopo da conta ativa.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-marketing-segments-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "patch": { "tags": [ "Disparos" ], "summary": "Atualizar segments", "description": "Atualiza nome, descrição e filtros do segmento.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "patch-email-marketing-segments-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "filters": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string", "default": "" }, "value2": { "type": "string" } }, "required": [ "id", "field", "operator" ], "additionalProperties": false } }, "syncNow": { "type": "boolean", "default": true } }, "required": [ "name", "description", "filters" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Email Marketing Segment", "value": { "name": "Clientes com e-mail válido - atualizado", "description": "Segmento atualizado via API", "filters": [], "syncNow": true } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" }, "delete": { "tags": [ "Disparos" ], "summary": "Excluir segments", "description": "Arquiva o segmento no escopo atual da conta de e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "delete-email-marketing-segments-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-marketing/segments/{id}/preview": { "get": { "tags": [ "Disparos" ], "summary": "Visualizar prévia de segments", "description": "Mostra uma prévia dos contatos elegíveis e a contagem total estimada do segmento.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-marketing-segments-id-preview", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" } }, "/api/email-marketing/segments/{id}/sync": { "post": { "tags": [ "Disparos" ], "summary": "Sincronizar segments", "description": "Sincroniza o segmento com o provedor de e-mail quando necessário.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-email-marketing-segments-id-sync", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-marketing/topics": { "get": { "tags": [ "Disparos" ], "summary": "Listar tópicos", "description": "Lista os tópicos de marketing por e-mail disponíveis para a conta ativa/resolvida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-email-marketing-topics", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "includeArchived", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de include archived." }, { "name": "refresh", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de refresh." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "post": { "tags": [ "Disparos" ], "summary": "Criar ou executar tópicos", "description": "Cria um tópico de marketing por e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-email-marketing-topics", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "visibility": { "type": "string", "enum": [ "PUBLIC", "PRIVATE" ], "default": "PRIVATE" }, "defaultSubscription": { "type": "string", "enum": [ "OPT_IN", "OPT_OUT" ], "default": "OPT_IN" } }, "required": [ "name" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Email Marketing Topic", "value": { "name": "Novidades do produto", "description": "Comunicações sobre lançamentos e melhorias", "visibility": "PRIVATE", "defaultSubscription": "OPT_IN" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/email-marketing/topics/{id}": { "patch": { "tags": [ "Disparos" ], "summary": "Atualizar tópicos", "description": "Atualiza os dados do tópico de marketing por e-mail.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "patch-email-marketing-topics-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "defaultSubscription": { "type": "string", "enum": [ "OPT_IN", "OPT_OUT" ] }, "name": { "type": "string" }, "visibility": { "type": "string", "enum": [ "PUBLIC", "PRIVATE" ] } }, "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Email Marketing Topic", "value": { "description": "Comunicações sobre lançamentos, melhorias e avisos importantes", "defaultSubscription": "OPT_IN" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" }, "delete": { "tags": [ "Disparos" ], "summary": "Excluir tópicos", "description": "Arquiva o tópico no escopo atual da conta ativa/resolvida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "delete-email-marketing-topics-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/feature-requests": { "get": { "tags": [ "Sugestões" ], "summary": "Listar sugestões de produto", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.", "operationId": "get-feature-requests", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de category." }, { "name": "onlyMine", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de only mine." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:read" }, "post": { "tags": [ "Sugestões" ], "summary": "Criar ou executar sugestões de produto", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "post-feature-requests", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "notifyOnStatusChange": { "type": "boolean" }, "tenantId": { "type": "string" } }, "required": [ "title", "description" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" } }, "/api/feature-requests/{id}": { "get": { "tags": [ "Sugestões" ], "summary": "Consultar sugestões de produto", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.", "operationId": "get-feature-requests-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:read" }, "patch": { "tags": [ "Sugestões" ], "summary": "Atualizar sugestões de produto", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "patch-feature-requests-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "BACKLOG", "UNDER_REVIEW", "PLANNED", "IN_PROGRESS", "COMPLETED", "REJECTED", "ON_HOLD" ] }, "priority": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "category": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToId": { "type": "string", "nullable": true }, "estimatedEffort": { "type": "string" }, "targetVersion": { "type": "string" }, "internalNotes": { "type": "string" }, "rejectionReason": { "type": "string" }, "duplicateOfId": { "type": "string", "nullable": true }, "notifyOnStatusChange": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" }, "delete": { "tags": [ "Sugestões" ], "summary": "Excluir sugestões de produto", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "delete-feature-requests-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" } }, "/api/feature-requests/{id}/comments": { "get": { "tags": [ "Sugestões" ], "summary": "Listar comments", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:read`.", "operationId": "get-feature-requests-id-comments", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:read" }, "post": { "tags": [ "Sugestões" ], "summary": "Criar ou executar comments", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "post-feature-requests-id-comments", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "isInternal": { "type": "boolean" } }, "required": [ "content" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" } }, "/api/feature-requests/{id}/vote": { "post": { "tags": [ "Sugestões" ], "summary": "Criar ou executar vote", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "post-feature-requests-id-vote", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" }, "delete": { "tags": [ "Sugestões" ], "summary": "Excluir vote", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `featureRequests:write`.", "operationId": "delete-feature-requests-id-vote", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "featureRequests:write" } }, "/api/flow-endpoints": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar endpoints de fluxo", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flow-endpoints", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "flowId": { "type": "string" }, "automationRules": { "type": "object", "additionalProperties": {} } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" }, "get": { "tags": [ "Fluxos e agentes" ], "summary": "Listar endpoints de fluxo", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flow-endpoints", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de flow." }, { "name": "isActive", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de is active." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" } }, "/api/flow-endpoints/{endpointId}": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Consultar endpoints de fluxo", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flow-endpoints-endpointId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de endpoint." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "patch": { "tags": [ "Fluxos e agentes" ], "summary": "Atualizar endpoints de fluxo", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "patch-flow-endpoints-endpointId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de endpoint." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "endpointId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "automationRules": { "type": "object", "additionalProperties": {} } }, "required": [ "endpointId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" }, "delete": { "tags": [ "Fluxos e agentes" ], "summary": "Excluir endpoints de fluxo", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "delete-flow-endpoints-endpointId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "endpointId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de endpoint." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flow-responses": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Listar flow responses", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flow-responses", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "contactId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de contact." }, { "name": "flowId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de flow." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Valor opcional de offset." }, { "name": "processed", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de processed." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar flow responses", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flow-responses", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flow-responses/batch-process": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar batch process", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flow-responses-batch-process", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Listar flows", "description": "Lista os flows disponíveis para a conta informada.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flows", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "dbOnly", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de db only." }, { "name": "source", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de source." }, { "name": "sync", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de sync." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar flows", "description": "Cria um flow e sincroniza com a Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "name": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string", "enum": [ "SIGN_UP", "SIGN_IN", "APPOINTMENT_BOOKING", "LEAD_GENERATION", "CONTACT_US", "CUSTOMER_SUPPORT", "SURVEY", "OTHER" ] } }, "endpointType": { "type": "string", "enum": [ "NONE", "META_PROVIDED", "CUSTOM" ], "default": "NONE" }, "json_version": { "type": "string" }, "endpoint_uri": { "anyOf": [ { "type": "string" }, {} ] }, "useCustomEndpoint": { "type": "boolean", "default": false }, "customEndpointName": { "type": "string" }, "customEndpointDescription": { "type": "string" }, "templateId": { "type": "string" } }, "required": [ "credentialId", "name", "categories", "endpointType", "useCustomEndpoint", "json_version" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Flow", "value": { "credentialId": "{{credentialId}}", "name": "Flow API", "categories": [ "OTHER" ], "endpointType": "CLOUD", "json_version": "7.1" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/{flowId}": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Consultar flows", "description": "Retorna os metadados do flow informado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flows-flowId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "patch": { "tags": [ "Fluxos e agentes" ], "summary": "Atualizar flows", "description": "Atualiza o flow localmente e no provedor.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "patch-flows-flowId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string", "enum": [ "SIGN_UP", "SIGN_IN", "APPOINTMENT_BOOKING", "LEAD_GENERATION", "CONTACT_US", "CUSTOMER_SUPPORT", "SURVEY", "OTHER" ] } }, "endpoint_uri": { "anyOf": [ { "type": "string" }, {} ] }, "flowId": { "type": "string" }, "endpointType": { "type": "string", "enum": [ "NONE", "META_PROVIDED", "CUSTOM" ] }, "useCustomEndpoint": { "type": "boolean" } }, "required": [ "flowId" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Flow", "value": { "name": "Flow API Atualizado", "categories": [ "OTHER" ], "endpoint_uri": "https://example.com/flow-endpoint" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" }, "delete": { "tags": [ "Fluxos e agentes" ], "summary": "Excluir flows", "description": "Exclui o flow da base local e da Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "delete-flows-flowId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/{flowId}/assets": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Listar assets", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flows-flowId-assets", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar assets", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-flowId-assets", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/{flowId}/deprecate": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Descontinuar flows", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-flowId-deprecate", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/{flowId}/json": { "get": { "tags": [ "Fluxos e agentes" ], "summary": "Listar json", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `flows:read`.", "operationId": "get-flows-flowId-json", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:read" }, "post": { "tags": [ "Fluxos e agentes" ], "summary": "Criar ou executar json", "description": "Atualiza a definição JSON do flow diretamente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-flowId-json", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "object", "properties": { "version": { "type": "string" }, "data_api_version": { "type": "string" }, "routing_model": { "type": "object", "additionalProperties": {} }, "screens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "terminal": { "type": "boolean" }, "data": { "type": "object", "additionalProperties": {} }, "layout": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SingleColumnLayout" ] }, "children": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "type", "children" ], "additionalProperties": false } }, "required": [ "id", "layout" ], "additionalProperties": false } } }, "required": [ "version", "screens" ], "additionalProperties": false }, "flowId": { "type": "string" } }, "required": [ "flowId" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Flow JSON", "value": { "json": { "screens": [], "routing_model": {} } } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/{flowId}/publish": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Publicar flows", "description": "Publica o flow na Meta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-flowId-publish", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "flowId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de fluxo." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/send": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Enviar flows", "description": "Envia uma mensagem com flow para um contato. O flow precisa estar publicado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-send", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string" }, "credentialId": { "type": "string" }, "flowId": { "type": "string" }, "flowCta": { "type": "string" }, "flowAction": { "type": "string", "enum": [ "navigate", "data_exchange" ] }, "flowActionPayload": { "type": "object", "properties": { "screen": { "type": "string" }, "data": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false }, "body": { "type": "string" }, "flowToken": { "type": "string" }, "header": { "type": "string" }, "footer": { "type": "string" }, "contextMessageId": { "type": "string" } }, "required": [ "to", "credentialId", "flowId", "flowCta", "flowAction", "body" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Send Flow Message", "value": { "to": "5511999999999", "credentialId": "{{credentialId}}", "flowId": "{{flowId}}", "flowCta": "Abrir fluxo", "flowAction": "navigate", "flowActionPayload": {}, "body": "Confira este fluxo interativo." } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/flows/sync": { "post": { "tags": [ "Fluxos e agentes" ], "summary": "Sincronizar flows", "description": "Importa e sincroniza flows da Meta para a base local.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `flows:write`.", "operationId": "post-flows-sync", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" } }, "required": [ "credentialId" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Sync Flows", "value": { "credentialId": "{{credentialId}}" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "flows:write" } }, "/api/gallery": { "get": { "tags": [ "Configurações" ], "summary": "Listar gallery", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-gallery", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "folderId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de folder." }, { "name": "isActive", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de is active." }, { "name": "labelIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de label ids." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Página da listagem, iniciando em 1." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Quantidade de itens por página." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de type." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar gallery", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-gallery", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "aiContext": { "type": "string", "nullable": true }, "folderId": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "IMAGE", "VIDEO", "AUDIO", "DOCUMENT", "LINK" ] }, "url": { "type": "string" }, "fileName": { "type": "string", "nullable": true }, "mimeType": { "type": "string", "nullable": true }, "fileSize": { "type": "number", "nullable": true }, "thumbnailUrl": { "nullable": true }, "includeInAgentContext": { "type": "boolean" }, "inheritFolderAiContext": { "type": "boolean" }, "labelIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "type", "url" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/gallery/{itemId}": { "get": { "tags": [ "Configurações" ], "summary": "Consultar gallery", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-gallery-itemId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de item." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar gallery", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-gallery-itemId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de item." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "aiContext": { "type": "string", "nullable": true }, "folderId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "includeInAgentContext": { "type": "boolean" }, "inheritFolderAiContext": { "type": "boolean" }, "labelIds": { "type": "array", "items": { "type": "string" } }, "thumbnailUrl": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir gallery", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-gallery-itemId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de item." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/gallery/upload": { "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar upload", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-gallery-upload", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/giphy/search": { "get": { "tags": [ "Conversas" ], "summary": "Listar search", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-giphy-search", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Valor opcional de offset." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/giphy/send": { "post": { "tags": [ "Conversas" ], "summary": "Enviar giphy", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-giphy-send", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/giphy/settings": { "get": { "tags": [ "Conversas" ], "summary": "Listar settings", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-giphy-settings", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/inbox/bootstrap": { "get": { "tags": [ "Conversas" ], "summary": "Listar bootstrap", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-inbox-bootstrap", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/inbox/conversations/{conversationId}/bootstrap": { "get": { "tags": [ "Conversas" ], "summary": "Listar bootstrap", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-inbox-conversations-conversationId-bootstrap", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de conversa." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/inbox/sidebar": { "get": { "tags": [ "Conversas" ], "summary": "Listar sidebar", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-inbox-sidebar", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/instagram/comments": { "get": { "tags": [ "Conversas" ], "summary": "Listar comments", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-instagram-comments", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Cursor opaco recebido na página anterior." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "mediaId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de media." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar comments", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-instagram-comments", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/instagram/comments/{id}": { "delete": { "tags": [ "Conversas" ], "summary": "Excluir comments", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-instagram-comments-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/instagram/content": { "get": { "tags": [ "Disparos" ], "summary": "Listar content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-instagram-content", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Cursor opaco recebido na página anterior." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "post": { "tags": [ "Disparos" ], "summary": "Criar ou executar content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-instagram-content", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/instagram/content/{id}": { "get": { "tags": [ "Disparos" ], "summary": "Consultar content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-instagram-content-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "delete": { "tags": [ "Disparos" ], "summary": "Excluir content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "delete-instagram-content-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" }, "patch": { "tags": [ "Disparos" ], "summary": "Atualizar content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "patch-instagram-content-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/instagram/content/native": { "get": { "tags": [ "Disparos" ], "summary": "Listar native", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-instagram-content-native", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" } }, "/api/instagram/content/sync": { "post": { "tags": [ "Disparos" ], "summary": "Sincronizar content", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-instagram-content-sync", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/instagram/content/upload": { "post": { "tags": [ "Disparos" ], "summary": "Criar ou executar upload", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-instagram-content-upload", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/instagram/ice-breakers": { "get": { "tags": [ "Configurações" ], "summary": "Listar ice breakers", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-instagram-ice-breakers", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar ice breakers", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-instagram-ice-breakers", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir ice breakers", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-instagram-ice-breakers", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/instagram/insights": { "get": { "tags": [ "Relatórios" ], "summary": "Listar insights", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-instagram-insights", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "mediaId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de media." }, { "name": "since", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de since." }, { "name": "timeframe", "in": "query", "required": false, "schema": { "type": "string", "default": "last_30_days" }, "description": "Valor opcional de timeframe." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "default": "profile" }, "description": "Valor opcional de type." }, { "name": "until", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de until." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/instagram/media": { "get": { "tags": [ "Disparos" ], "summary": "Listar mídias", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-instagram-media", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" } }, "/api/instagram/persistent-menu": { "get": { "tags": [ "Configurações" ], "summary": "Listar persistent menu", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-instagram-persistent-menu", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar persistent menu", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-instagram-persistent-menu", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir persistent menu", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-instagram-persistent-menu", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/instagram/profile-sync": { "post": { "tags": [ "Contatos e CRM" ], "summary": "Criar ou executar profile sync", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "post-instagram-profile-sync", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/instagram/quick-automations": { "get": { "tags": [ "Automações" ], "summary": "Listar quick automations", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:read`.", "operationId": "get-instagram-quick-automations", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "automations:read" }, "post": { "tags": [ "Automações" ], "summary": "Criar ou executar quick automations", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.", "operationId": "post-instagram-quick-automations", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "recipeSlug": { "type": "string" }, "automationName": { "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "publicReplyMessage": { "type": "string", "nullable": true }, "privateReplyMessage": { "type": "string", "nullable": true }, "quickReplyMessage": { "type": "string", "nullable": true }, "quickReplyOptions": { "type": "string", "nullable": true }, "aiAgentId": { "type": "string", "nullable": true }, "aiAgentInstructions": { "type": "string", "nullable": true }, "sourceSurface": { "type": "string", "enum": [ "instagram-content-tab", "instagram-publish-dialog" ], "default": "instagram-content-tab" }, "instagramPublishedContentId": { "type": "string", "nullable": true }, "existingMedia": { "type": "object", "properties": { "igMediaId": { "type": "string" }, "permalink": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "thumbnailUrl": { "type": "string", "nullable": true } }, "required": [ "igMediaId" ], "additionalProperties": false, "nullable": true } }, "required": [ "credentialId", "recipeSlug", "sourceSurface" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "automations:write" } }, "/api/instagram/quick-automations/{id}": { "patch": { "tags": [ "Automações" ], "summary": "Atualizar quick automations", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `automations:write`.", "operationId": "patch-instagram-quick-automations-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "recipeSlug": { "type": "string" }, "automationName": { "type": "string", "nullable": true }, "keywords": { "type": "string", "nullable": true }, "publicReplyMessage": { "type": "string", "nullable": true }, "privateReplyMessage": { "type": "string", "nullable": true }, "quickReplyMessage": { "type": "string", "nullable": true }, "quickReplyOptions": { "type": "string", "nullable": true }, "aiAgentId": { "type": "string", "nullable": true }, "aiAgentInstructions": { "type": "string", "nullable": true }, "existingMedia": { "type": "object", "properties": { "igMediaId": { "type": "string" }, "permalink": { "type": "string", "nullable": true }, "caption": { "type": "string", "nullable": true }, "thumbnailUrl": { "type": "string", "nullable": true } }, "required": [ "igMediaId" ], "additionalProperties": false, "nullable": true } }, "required": [ "credentialId", "recipeSlug" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "automations:write" } }, "/api/instagram/referrals": { "get": { "tags": [ "Configurações" ], "summary": "Listar referrals", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-instagram-referrals", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar referrals", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-instagram-referrals", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "ref": { "type": "string" }, "campaignName": { "type": "string" }, "source": { "type": "string" }, "destination": { "type": "string" }, "expiresAt": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": [ "credentialId", "name", "username" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/instagram/referrals/{id}": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar referrals", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-instagram-referrals-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "EXPIRED" ] }, "name": { "type": "string" }, "campaignName": { "type": "string", "nullable": true }, "destination": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir referrals", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-instagram-referrals-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/instagram/usage": { "get": { "tags": [ "Configurações" ], "summary": "Listar usage", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-instagram-usage", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" } }, "/api/internal/channels": { "get": { "tags": [ "Chat interno" ], "summary": "Listar channels", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.", "operationId": "get-internal-channels", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:read" }, "post": { "tags": [ "Chat interno" ], "summary": "Criar ou executar channels", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "post-internal-channels", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}": { "get": { "tags": [ "Chat interno" ], "summary": "Consultar channels", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.", "operationId": "get-internal-channels-channelId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:read" }, "patch": { "tags": [ "Chat interno" ], "summary": "Atualizar channels", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "patch-internal-channels-channelId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}/members": { "post": { "tags": [ "Chat interno" ], "summary": "Criar ou executar membros", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "post-internal-channels-channelId-members", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" }, "delete": { "tags": [ "Chat interno" ], "summary": "Excluir membros", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "delete-internal-channels-channelId-members", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}/messages": { "post": { "tags": [ "Chat interno" ], "summary": "Criar ou executar mensagens", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "post-internal-channels-channelId-messages", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}/messages/{messageId}": { "patch": { "tags": [ "Chat interno" ], "summary": "Atualizar mensagens", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "patch-internal-channels-channelId-messages-messageId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de mensagem." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" }, "delete": { "tags": [ "Chat interno" ], "summary": "Excluir mensagens", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "delete-internal-channels-channelId-messages-messageId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de mensagem." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}/reactions": { "post": { "tags": [ "Chat interno" ], "summary": "Criar ou executar reactions", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:write`.", "operationId": "post-internal-channels-channelId-reactions", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:write" } }, "/api/internal/channels/{channelId}/read-state": { "patch": { "tags": [ "Chat interno" ], "summary": "Atualizar read state", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.", "operationId": "patch-internal-channels-channelId-read-state", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de canal." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "lastReadMessageId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:read" } }, "/api/internal/unread-count": { "get": { "tags": [ "Chat interno" ], "summary": "Listar contagem de não lidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `internalChat:read`.", "operationId": "get-internal-unread-count", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "internalChat:read" } }, "/api/journeys": { "get": { "tags": [ "Jornadas" ], "summary": "Listar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" }, "post": { "tags": [ "Jornadas" ], "summary": "Criar ou executar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "credentialId": { "type": "string", "nullable": true }, "variables": { "type": "object", "additionalProperties": {} }, "activate": { "type": "boolean", "default": false } }, "required": [ "templateId", "variables", "activate" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}": { "get": { "tags": [ "Jornadas" ], "summary": "Consultar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-journeyId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" }, "patch": { "tags": [ "Jornadas" ], "summary": "Atualizar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "patch-journeys-journeyId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "variables": { "type": "object", "additionalProperties": {} }, "credentialId": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/activate": { "post": { "tags": [ "Jornadas" ], "summary": "Ativar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-journeyId-activate", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/analytics": { "get": { "tags": [ "Jornadas" ], "summary": "Listar análises", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-journeyId-analytics", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" } }, "/api/journeys/{journeyId}/archive": { "post": { "tags": [ "Jornadas" ], "summary": "Arquivar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-journeyId-archive", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/contacts": { "get": { "tags": [ "Jornadas" ], "summary": "Listar contacts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-journeyId-contacts", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" }, "post": { "tags": [ "Jornadas" ], "summary": "Criar ou executar contacts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-journeyId-contacts", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contactId": { "type": "string" }, "contactIds": { "type": "array", "items": { "type": "string" } }, "labelId": { "type": "string" }, "restartExisting": { "type": "boolean", "default": false }, "reactivateOptedOut": { "type": "boolean", "default": false } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/contacts/{enrollmentId}": { "patch": { "tags": [ "Jornadas" ], "summary": "Atualizar contacts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "patch-journeys-journeyId-contacts-enrollmentId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." }, { "name": "enrollmentId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de inscrição." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "pause", "resume", "retry", "complete", "opt_out" ] }, "reason": { "type": "string", "nullable": true } }, "required": [ "action" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/duplicate": { "post": { "tags": [ "Jornadas" ], "summary": "Duplicar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-journeyId-duplicate", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/events": { "get": { "tags": [ "Jornadas" ], "summary": "Listar eventos", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-journeyId-events", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" } }, "/api/journeys/{journeyId}/pause": { "post": { "tags": [ "Jornadas" ], "summary": "Pausar journeys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-journeyId-pause", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/{journeyId}/run-now": { "post": { "tags": [ "Jornadas" ], "summary": "Criar ou executar run now", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "post-journeys-journeyId-run-now", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Header opcional Idempotency-Key." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" } }, "/api/journeys/{journeyId}/runs": { "get": { "tags": [ "Jornadas" ], "summary": "Listar runs", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-journeyId-runs", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "journeyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de jornada." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" } }, "/api/journeys/contact-options": { "get": { "tags": [ "Jornadas" ], "summary": "Listar contact options", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "get-journeys-contact-options", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "contactId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de contact." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/templates": { "get": { "tags": [ "Jornadas" ], "summary": "Listar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-templates", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "custom", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de custom." }, { "name": "includeUnpublished", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de include unpublished." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" }, "post": { "tags": [ "Jornadas" ], "summary": "Criar ou executar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "post-journeys-templates", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "baseTemplateId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean", "default": true }, "defaultVariables": { "type": "object", "additionalProperties": {} } }, "required": [ "baseTemplateId", "name", "isPublished", "defaultVariables" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/templates/{templateId}": { "get": { "tags": [ "Jornadas" ], "summary": "Consultar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "get-journeys-templates-templateId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de template." }, { "name": "includeUnpublished", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de include unpublished." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" }, "patch": { "tags": [ "Jornadas" ], "summary": "Atualizar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:write`.", "operationId": "patch-journeys-templates-templateId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de template." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isPublished": { "type": "boolean" }, "defaultVariables": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:write" } }, "/api/journeys/templates/{templateId}/simulate": { "post": { "tags": [ "Jornadas" ], "summary": "Criar ou executar simulate", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `journeys:read`.", "operationId": "post-journeys-templates-templateId-simulate", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de template." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": {} }, "credentialId": { "type": "string", "nullable": true } }, "required": [ "variables" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "journeys:read" } }, "/api/media/proxy": { "get": { "tags": [ "Conversas" ], "summary": "Listar proxy", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-media-proxy", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "fallback", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de fallback." }, { "name": "url", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de url." }, { "name": "content-length", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Header opcional content-length." }, { "name": "cache-control", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Header opcional cache-control." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "204": { "description": "Operação concluída sem conteúdo." }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/media/upload": { "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar upload", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-media-upload", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "get": { "tags": [ "Conversas" ], "summary": "Listar upload", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-media-upload", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/messages": { "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar mensagens", "description": "Envia uma mensagem de texto simples. Use `previewUrl: true` para gerar preview de links.\n\nEnvia mensagem de texto com preview automatico do link.\n\nEnvia uma resposta citando (quote) uma mensagem anterior usando `contextMessageId`.\n\nEnvia uma imagem com legenda opcional. Formatos: JPEG, PNG. Max 5 MB.\n\nEnvia um video com legenda opcional. Formato: MP4. Max 16 MB.\n\nEnvia um audio. Formato: OGG/OPUS (audio de voz), MP3, AAC. Max 16 MB.\n\nEnvia um documento/arquivo. Formatos: PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT, CSV, ZIP. Max 100 MB.\n\nEnvia uma figurinha. Formato: WebP. Max 100 KB (estatico) / 500 KB (animado).\n\nEnvia uma localizacao geografica com nome e endereco opcionais.\n\nEnvia um ou mais cartoes de contato no formato vCard.\n\nEnvia uma reacao (emoji) a uma mensagem especifica. Envie emoji vazio para remover reacao.\n\nEnvia mensagem com ate 3 botoes de resposta rapida. Cada botao tem `id` (max 256 chars) e `title` (max 20 chars).\n\nEnvia mensagem com menu em lista. Ate 10 secoes com ate 10 itens cada. Titulo do item max 24 chars, descricao max 72 chars.\n\nEnvia mensagem com botao de CTA (Call to Action) que abre uma URL.\n\nEnvia uma enquete com ate 12 opcoes. Use `allow_multiple_answers` para permitir multipla selecao.\n\nSolicita que o contato compartilhe sua localizacao.\n\nEnvia um template simples sem parametros. Ideal para templates de boas-vindas ou notificacoes fixas.\n\nEnvia um template com parametros dinamicos. Os parametros devem corresponder aos placeholders {{1}}, {{2}}, etc. do template aprovado.\n\nEnvia um template com imagem no header e parametros no body.\n\nEnvia quick replies no Instagram Direct. Use uma credencial Instagram ativa e o identificador do destinatário com prefixo `ig:`.\n\nEnvia um e-mail usando a conta de canal informada em `channelAccountId`.\n\nResponde a uma conversa de e-mail reutilizando `contextMessageId`, `inReplyTo` e `references`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `messages:send`.", "operationId": "post-messages", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "idempotency-key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Header opcional idempotency-key." }, { "name": "x-idempotency-key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Header opcional x-idempotency-key." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "to": { "type": "string" }, "type": { "type": "string", "example": "text" }, "text": { "type": "string", "example": "Ola! Esta e uma mensagem enviada via API." }, "previewUrl": { "type": "boolean", "example": false }, "clientRequestId": { "type": "string" }, "channelAccountId": { "type": "string" }, "contextMessageId": { "type": "string", "nullable": true }, "conversationId": { "type": "string" }, "channel": { "type": "string" }, "email": { "type": "object", "properties": { "subject": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "replyTo": { "type": "string" }, "fromAlias": { "type": "string" }, "includeSignature": { "type": "boolean" }, "htmlBody": { "type": "string" }, "inReplyTo": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "required": [ "to" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Send Text Message", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "text", "text": "Ola! Esta e uma mensagem enviada via API.", "previewUrl": false } }, "exemplo2": { "summary": "Send Text with Link Preview", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "text", "text": "Confira nosso site: https://example.com", "previewUrl": true } }, "exemplo3": { "summary": "Reply to Message (Quote)", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "text", "text": "Esta e uma resposta citando a mensagem anterior.", "contextMessageId": "{{lastMessageId}}" } }, "exemplo4": { "summary": "Send Image", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "image", "image": { "link": "https://example.com/image.jpg", "caption": "Legenda da imagem" } } }, "exemplo5": { "summary": "Send Video", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "video", "video": { "link": "https://example.com/video.mp4", "caption": "Legenda do video" } } }, "exemplo6": { "summary": "Send Audio", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "audio", "audio": { "link": "https://example.com/audio.ogg" } } }, "exemplo7": { "summary": "Send Document", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "document", "document": { "link": "https://example.com/document.pdf", "caption": "Proposta comercial", "filename": "proposta-2024.pdf" } } }, "exemplo8": { "summary": "Send Sticker", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "sticker", "sticker": { "link": "https://example.com/sticker.webp" } } }, "exemplo9": { "summary": "Send Location", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "location", "location": { "latitude": -23.5505, "longitude": -46.6333, "name": "Sao Paulo", "address": "Praca da Se, Sao Paulo - SP" } } }, "exemplo10": { "summary": "Send Contact Card", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "contacts", "contacts": [ { "name": { "formatted_name": "Joao Silva", "first_name": "Joao", "last_name": "Silva" }, "phones": [ { "phone": "+5511999999999", "type": "CELL" } ], "emails": [ { "email": "joao@example.com", "type": "WORK" } ] } ] } }, "exemplo11": { "summary": "Send Reaction", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "reaction", "reaction": { "message_id": "{{lastMessageId}}", "emoji": "👍" } } }, "exemplo12": { "summary": "Send Button Message", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "interactive_button", "interactive": { "type": "button", "body": { "text": "Como voce avalia nosso atendimento?" }, "action": { "buttons": [ { "type": "reply", "reply": { "id": "btn_otimo", "title": "Otimo" } }, { "type": "reply", "reply": { "id": "btn_bom", "title": "Bom" } }, { "type": "reply", "reply": { "id": "btn_ruim", "title": "Ruim" } } ] } } } }, "exemplo13": { "summary": "Send List Message", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "interactive_list", "interactive": { "type": "list", "header": { "type": "text", "text": "Nosso Menu" }, "body": { "text": "Selecione uma opcao abaixo:" }, "footer": { "text": "Powered by API" }, "action": { "button": "Ver Opcoes", "sections": [ { "title": "Atendimento", "rows": [ { "id": "row_suporte", "title": "Suporte Tecnico", "description": "Fale com nosso time de suporte" }, { "id": "row_vendas", "title": "Vendas", "description": "Informacoes sobre nossos planos" } ] }, { "title": "Informacoes", "rows": [ { "id": "row_horarios", "title": "Horarios", "description": "Horarios de atendimento" }, { "id": "row_faq", "title": "FAQ", "description": "Perguntas frequentes" } ] } ] } } } }, "exemplo14": { "summary": "Send CTA URL Button", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "interactive_cta_url", "interactive": { "type": "cta_url", "body": { "text": "Acesse nosso portal para mais informacoes." }, "action": { "name": "cta_url", "parameters": { "display_text": "Acessar Portal", "url": "https://example.com/portal" } } } } }, "exemplo15": { "summary": "Send Poll", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "interactive_poll", "interactive": { "type": "poll", "body": { "text": "Qual seu horario preferido para reunioes?" }, "action": { "name": "poll", "parameters": { "question": "Qual seu horario preferido para reunioes?", "options": [ { "title": "09:00 - 10:00" }, { "title": "14:00 - 15:00" }, { "title": "16:00 - 17:00" } ], "allow_multiple_answers": false } } } } }, "exemplo16": { "summary": "Send Location Request", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "interactive_location_request", "interactive": { "type": "location_request_message", "body": { "text": "Por favor, compartilhe sua localizacao para que possamos encontrar a loja mais proxima." }, "action": { "name": "send_location" } } } }, "exemplo17": { "summary": "Send Template (Simple)", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "template", "template": { "name": "hello_world", "language": "pt_BR" } } }, "exemplo18": { "summary": "Send Template (With Parameters)", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "template", "template": { "name": "order_confirmation", "language": "pt_BR", "components": [ { "type": "body", "parameters": [ { "type": "text", "text": "Joao" }, { "type": "text", "text": "#12345" }, { "type": "text", "text": "R$ 199,90" } ] } ] } } }, "exemplo19": { "summary": "Send Template (With Header Image)", "value": { "credentialId": "{{credentialId}}", "to": "{{recipientPhone}}", "type": "template", "template": { "name": "promo_template", "language": "pt_BR", "components": [ { "type": "header", "parameters": [ { "type": "image", "image": { "link": "https://example.com/promo-banner.jpg" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "30%" }, { "type": "text", "text": "31/12/2024" } ] } ] } } }, "exemplo20": { "summary": "Send Instagram Quick Replies", "value": { "credentialId": "{{credentialId}}", "channel": "INSTAGRAM_DIRECT_LOGIN", "to": "ig:{{instagramRecipientId}}", "type": "instagram_quick_replies", "text": "Como podemos ajudar hoje?", "quick_replies": [ { "title": "Ver pedidos", "payload": "orders" }, { "title": "Falar com time", "payload": "human_handoff" }, { "title": "Receber catálogo", "payload": "catalog" } ] } }, "exemplo21": { "summary": "Send Email Message (HTML)", "value": { "channelAccountId": "{{channelAccountId}}", "channel": "EMAIL", "to": "{{recipientEmail}}", "type": "text", "text": "Olá! Esta é a versão em texto do e-mail.", "email": { "subject": "Boas-vindas à CloudWhats", "cc": [ "time@example.com" ], "bcc": [ "auditoria@example.com" ], "replyTo": "suporte@example.com", "fromAlias": "Time CloudWhats", "htmlBody": "Olá!
Esta é a versão em HTML do e-mail.
" } } }, "exemplo22": { "summary": "Reply to Email Thread", "value": { "channelAccountId": "{{channelAccountId}}", "channel": "EMAIL", "to": "{{recipientEmail}}", "contextMessageId": "{{lastMessageId}}", "type": "text", "text": "Retomando nosso contato por e-mail.", "email": { "subject": "Re: Boas-vindas à CloudWhats", "replyTo": "suporte@example.com", "htmlBody": "Retomando nosso contato por e-mail.
", "inReplyTo": "{{emailMessageHeaderId}}", "references": [ "{{emailMessageHeaderId}}" ] } } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "messages:send" } }, "/api/messages/forward": { "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar forward", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `messages:send`.", "operationId": "post-messages-forward", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceMessageId": { "type": "string" }, "targetConversationIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "sourceMessageId", "targetConversationIds" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "messages:send" } }, "/api/notes": { "get": { "tags": [ "Conversas" ], "summary": "Listar notes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-notes", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar notes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-notes", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientRequestId": { "type": "string" }, "title": { "type": "string", "default": "" }, "content": { "type": "string", "default": "" }, "color": { "type": "string" }, "status": { "type": "string" }, "priority": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "isFavorite": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "posX": { "type": "number" }, "posY": {}, "width": {}, "height": {}, "zIndex": { "type": "number" }, "pinnedRoute": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "patch": { "tags": [ "Conversas" ], "summary": "Atualizar notes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "patch-notes", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientRequestId": { "type": "string" }, "title": { "type": "string", "default": "" }, "content": { "type": "string", "default": "" }, "color": { "type": "string" }, "status": { "type": "string" }, "priority": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "isFavorite": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMinimized": { "type": "boolean" }, "posX": { "type": "number" }, "posY": {}, "width": {}, "height": {}, "zIndex": { "type": "number" }, "pinnedRoute": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir notes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-notes", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "ids": { "type": "array", "items": {} } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/notifications": { "get": { "tags": [ "Conversas" ], "summary": "Listar notificações", "description": "Lista notificações com paginação por cursor e filtros opcionais.\n\nRetorna somente a contagem de notificações não lidas no escopo informado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-notifications", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "channelAccountIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account ids." }, { "name": "countOnly", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de count only." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "credentialIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de credential ids." }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Cursor opaco recebido na página anterior." }, { "name": "from", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Início do período." }, { "name": "isRead", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de is read." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." }, { "name": "to", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Fim do período." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de type." }, { "name": "types", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de types." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "patch": { "tags": [ "Conversas" ], "summary": "Atualizar notificações", "description": "Marca como lidas todas as notificações compatíveis com os filtros informados.\n\nMarca um conjunto específico de notificações como lidas.\n\nMarca um conjunto específico de notificações como não lidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "patch-notifications", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "example": "markAllRead" }, "types": { "type": "array", "items": { "type": "string", "example": "task_assigned" } }, "credentialIds": { "type": "array", "items": { "type": "string", "example": "{{credentialId}}" } }, "channelAccountIds": { "type": "array", "items": { "type": "string", "example": "{{channelAccountId}}" } }, "from": { "type": "string", "example": "2026-01-01T00:00:00.000Z" }, "to": { "type": "string", "example": "2026-01-31T23:59:59.999Z" } } }, "examples": { "exemplo1": { "summary": "Mark All as Read", "value": { "action": "markAllRead", "types": [ "task_assigned" ], "credentialIds": [ "{{credentialId}}" ], "channelAccountIds": [ "{{channelAccountId}}" ], "from": "2026-01-01T00:00:00.000Z", "to": "2026-01-31T23:59:59.999Z" } }, "exemplo2": { "summary": "Mark Many as Read", "value": { "action": "markManyRead", "ids": [ "{{notificationId}}" ] } }, "exemplo3": { "summary": "Mark Many as Unread", "value": { "action": "markManyUnread", "ids": [ "{{notificationId}}" ] } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir notificações", "description": "Exclui notificações por lista explícita de IDs.\n\nRemove notificações com base em filtros, incluindo opção para apagar apenas as já lidas.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-notifications", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "example": "{{notificationId}}" } } } }, "examples": { "exemplo1": { "summary": "Delete Many Notifications", "value": { "ids": [ "{{notificationId}}" ] } }, "exemplo2": { "summary": "Clear Notifications by Filter", "value": { "types": [ "task_assigned" ], "credentialIds": [ "{{credentialId}}" ], "channelAccountIds": [ "{{channelAccountId}}" ], "onlyRead": true, "from": "2026-01-01T00:00:00.000Z", "to": "2026-01-31T23:59:59.999Z" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/notifications/{id}": { "patch": { "tags": [ "Conversas" ], "summary": "Atualizar notificações", "description": "Marca uma única notificação como lida.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "patch-notifications-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir notificações", "description": "Exclui uma única notificação e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-notifications-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/notifications/action-center": { "get": { "tags": [ "Conversas" ], "summary": "Listar action center", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-notifications-action-center", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "channelAccountIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account ids." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "credentialIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de credential ids." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "patch": { "tags": [ "Conversas" ], "summary": "Atualizar action center", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "patch-notifications-action-center", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "action": { "const": "snooze" }, "itemId": { "type": "string" }, "until": { "type": "string" } }, "required": [ "action", "itemId", "until" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "const": "dismiss" }, "itemId": { "type": "string" } }, "required": [ "action", "itemId" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "const": "restore" }, "itemId": { "type": "string" } }, "required": [ "action", "itemId" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "const": "restoreAll" } }, "required": [ "action" ], "additionalProperties": false } ] } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/orders": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar pedidos", "description": "Lista pedidos usando paginação por página. A resposta traz `orders` e `pagination`.\n\nMantém compatibilidade com consumidores antigos que ainda usam cursor.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-orders", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Página da listagem, iniciando em 1." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Quantidade de itens por página." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Filtro opcional por status do pedido" } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" } }, "/api/orders/{orderId}": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Consultar pedidos", "description": "Retorna o pedido consolidado, incluindo alertas operacionais e possíveis dados mesclados com Nuvemshop.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-orders-orderId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de pedido." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "patch": { "tags": [ "Contatos e CRM" ], "summary": "Atualizar pedidos", "description": "Atualiza status, rastreio, observações internas e motivo de cancelamento. A rota pode sincronizar automaticamente com a Nuvemshop quando houver vínculo.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "patch-orders-orderId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de pedido." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": {}, "trackingCode": { "type": "string" }, "internalNotes": { "type": "string" }, "cancelReason": { "type": "string" } }, "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Order", "value": { "status": "CONFIRMED", "trackingCode": "BR123456789", "internalNotes": "Pedido confirmado e em separação.", "cancelReason": null } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/orders/{orderId}/enrich-products": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar enrich products", "description": "Enriquece os itens do pedido com nomes do catálogo Meta quando disponíveis. Em caso de indisponibilidade do catálogo, retorna fallback com os dados já salvos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-orders-orderId-enrich-products", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de pedido." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" } }, "/api/orders/{orderId}/export-nuvemshop": { "post": { "tags": [ "Contatos e CRM" ], "summary": "Exportar pedidos", "description": "Exporta um pedido do WhatsApp para a Nuvemshop. Exige integração ativa e produtos compatíveis já sincronizados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "post-orders-orderId-export-nuvemshop", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de pedido." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/orders/settings": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar settings", "description": "Consulta as configurações de resposta automática por status e o resumo de conflito com automações de integração.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-orders-settings", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "patch": { "tags": [ "Contatos e CRM" ], "summary": "Atualizar settings", "description": "Atualiza os textos de resposta automática por status. Cada mensagem aceita até 2000 caracteres.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "patch-orders-settings", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "autoReplyEnabled": { "type": "boolean" }, "autoReplyOnConfirmed": { "type": "string", "nullable": true }, "autoReplyOnShipped": { "type": "string", "nullable": true }, "autoReplyOnPending": { "type": "string", "nullable": true }, "autoReplyOnPreparing": { "type": "string", "nullable": true }, "autoReplyOnDelivered": { "type": "string", "nullable": true }, "autoReplyOnCancelled": { "type": "string", "nullable": true }, "autoReplyOnRefunded": { "type": "string", "nullable": true } }, "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Order Settings", "value": { "autoReplyEnabled": true, "autoReplyOnConfirmed": "Olá, {customerName}! Seu pedido #{orderId} foi confirmado com sucesso.", "autoReplyOnShipped": "Seu pedido #{orderId} já está a caminho. Código de rastreio: {trackingCode}." } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/orders/stats": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar stats", "description": "Retorna contagem por status, total de pedidos, pedidos do dia, receita total e pedidos ativos.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-orders-stats", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" } }, "/api/organizations": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar organizações", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-organizations", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "lifecycle", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de lifecycle." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Valor opcional de offset." }, { "name": "ownerId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de owner." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de segment." }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de sort." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "post": { "tags": [ "Contatos e CRM" ], "summary": "Criar ou executar organizações", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "post-organizations", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/organizations/{organizationId}": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Consultar organizações", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-organizations-organizationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de organização." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "patch": { "tags": [ "Contatos e CRM" ], "summary": "Atualizar organizações", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "patch-organizations-organizationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de organização." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" }, "delete": { "tags": [ "Contatos e CRM" ], "summary": "Excluir organizações", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "delete-organizations-organizationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de organização." }, { "name": "detach", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de detach." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/organizations/{organizationId}/360": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar 360", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-organizations-organizationId-360", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de organização." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" } }, "/api/organizations/resolve-by-email": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar resolve by email", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-organizations-resolve-by-email", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "email", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de email." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" } }, "/api/phone-numbers": { "get": { "tags": [ "Contas conectadas" ], "summary": "Listar números de telefone", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `credentials:read`.", "operationId": "get-phone-numbers", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "credentials:read" } }, "/api/quick-replies": { "get": { "tags": [ "Conversas" ], "summary": "Listar respostas rápidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-quick-replies", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de category." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Texto usado na busca." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar respostas rápidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-quick-replies", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcut": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "category": { "type": "string" }, "variables": { "type": "array", "items": { "type": "string" } }, "isGlobal": { "type": "boolean", "default": false } }, "required": [ "shortcut", "title", "content", "variables", "isGlobal" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/quick-replies/{replyId}": { "get": { "tags": [ "Conversas" ], "summary": "Consultar respostas rápidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-quick-replies-replyId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "replyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de resposta rápida." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "patch": { "tags": [ "Conversas" ], "summary": "Atualizar respostas rápidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "patch-quick-replies-replyId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "replyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de resposta rápida." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "shortcut": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "category": { "type": "string" }, "variables": { "type": "array", "items": { "type": "string" } }, "isGlobal": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir respostas rápidas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-quick-replies-replyId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "replyId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de resposta rápida." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/reminders": { "get": { "tags": [ "Conversas" ], "summary": "Listar lembretes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-reminders", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "all", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de all." }, { "name": "conversationId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de conversation." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "due", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de due." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Página da listagem, iniciando em 1." }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Quantidade de itens por página." }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de query." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de type." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" } }, "/api/reminders/{reminderId}": { "patch": { "tags": [ "Conversas" ], "summary": "Atualizar lembretes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "patch-reminders-reminderId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "reminderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de lembrete." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "action": { "const": "cancel" } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "const": "reschedule" }, "remindAt": { "type": "string" }, "note": { "type": "string", "nullable": true } }, "required": [ "action", "remindAt" ], "additionalProperties": false } ] } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir lembretes", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-reminders-reminderId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "reminderId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de lembrete." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/reports": { "get": { "tags": [ "Relatórios" ], "summary": "Listar reports", "description": "Retorna o conjunto completo de relatórios: visão geral, conversas, pessoas, equipes, CRM, pedidos, tarefas, chamadas e mais.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-reports", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de end date." }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Período consolidado do relatório." }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de start date." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/reports/{type}": { "get": { "tags": [ "Relatórios" ], "summary": "Consultar reports", "description": "Template genérico para testar qualquer tipo listado na variável `reportType`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-reports-type", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de type." }, { "name": "aiAgentIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de ai agent ids." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "credentialIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de credential ids." }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de end date." }, { "name": "labelIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de label ids." }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Período consolidado do relatório." }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de start date." }, { "name": "teamIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de team ids." }, { "name": "userIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de user ids." }, { "name": "widgetIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de widget ids." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/reports/export": { "post": { "tags": [ "Relatórios" ], "summary": "Exportar reports", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "post-reports-export", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "current", "all" ] }, "reportType": { "type": "string", "enum": [ "command-center", "overview", "conversations", "users", "teams", "labels", "phone-numbers", "widget", "ai", "sla", "satisfaction", "usability", "contacts", "crm", "orders", "tasks", "calls" ] }, "format": { "type": "string", "enum": [ "xlsx", "csv", "json", "pdf" ] }, "includeCharts": { "type": "boolean", "default": true }, "includeLists": { "type": "boolean", "default": true }, "filters": { "type": "object", "properties": { "period": {}, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "required": [ "period" ], "additionalProperties": false } }, "required": [ "scope", "format" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/reports/preferences": { "get": { "tags": [ "Relatórios" ], "summary": "Listar preferences", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-reports-preferences", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" }, "patch": { "tags": [ "Relatórios" ], "summary": "Atualizar preferences", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "patch-reports-preferences", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultReportType": { "type": "string" }, "favoriteReportTypes": { "type": "array", "items": {} }, "recentReportTypes": { "type": "array", "items": {} }, "navigationHidden": { "type": "boolean" } }, "required": [ "defaultReportType", "favoriteReportTypes", "recentReportTypes", "navigationHidden" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/scheduled-messages": { "get": { "tags": [ "Conversas" ], "summary": "Listar mensagens agendadas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:read`.", "operationId": "get-scheduled-messages", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:read" }, "post": { "tags": [ "Conversas" ], "summary": "Criar ou executar mensagens agendadas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "post-scheduled-messages", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "channelAccountId": { "type": "string" }, "to": { "type": "string" }, "scheduledFor": { "type": "string" }, "conversationId": { "type": "string" }, "email": { "type": "object", "properties": { "subject": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "replyTo": { "type": "string" }, "fromAlias": { "type": "string" }, "includeSignature": { "type": "boolean" }, "htmlBody": { "type": "string" }, "inReplyTo": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "type": { "type": "string", "enum": [ "text", "template", "interactive", "image", "video", "audio", "document", "sticker", "location", "contacts", "reaction" ] }, "text": { "type": "string" }, "previewUrl": { "type": "boolean" }, "template": { "type": "object", "properties": { "name": { "type": "string" }, "language": { "type": "string" }, "components": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "name", "language" ], "additionalProperties": false }, "interactive": { "type": "object", "additionalProperties": {} }, "media": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "image": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "video": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "audio": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "document": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" }, "filename": { "type": "string" }, "caption": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "sticker": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "link": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false } ] }, "location": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" } }, "required": [ "latitude", "longitude" ], "additionalProperties": false }, "contacts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "reaction": { "type": "object", "properties": { "message_id": { "type": "string" }, "emoji": { "type": "string" } }, "required": [ "message_id", "emoji" ], "additionalProperties": false } }, "required": [ "to", "scheduledFor", "type" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" }, "delete": { "tags": [ "Conversas" ], "summary": "Excluir mensagens agendadas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `conversations:write`.", "operationId": "delete-scheduled-messages", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "conversations:write" } }, "/api/sentinel/alerts": { "get": { "tags": [ "Relatórios" ], "summary": "Listar alerts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-alerts", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" }, "patch": { "tags": [ "Relatórios" ], "summary": "Atualizar alerts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "patch-sentinel-alerts", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string", "enum": [ "acknowledge", "resolve", "dismiss" ] }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "required": [ "ids", "action" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/alerts/{alertId}": { "get": { "tags": [ "Relatórios" ], "summary": "Consultar alerts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-alerts-alertId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de alerta." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" }, "patch": { "tags": [ "Relatórios" ], "summary": "Atualizar alerts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "patch-sentinel-alerts-alertId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de alerta." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "acknowledge", "resolve", "dismiss" ] }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "required": [ "action" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/alerts/{alertId}/linear": { "post": { "tags": [ "Relatórios" ], "summary": "Criar ou executar linear", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "post-sentinel-alerts-alertId-linear", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de alerta." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/analytics": { "get": { "tags": [ "Relatórios" ], "summary": "Listar análises", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-analytics", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/anomalies": { "get": { "tags": [ "Relatórios" ], "summary": "Listar anomalies", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-anomalies", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/anomalies/detail": { "get": { "tags": [ "Relatórios" ], "summary": "Listar detail", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-anomalies-detail", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/backlog-analysis": { "post": { "tags": [ "Relatórios" ], "summary": "Criar ou executar backlog analysis", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "post-sentinel-backlog-analysis", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/briefing": { "get": { "tags": [ "Relatórios" ], "summary": "Listar briefing", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-briefing", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/config": { "get": { "tags": [ "Relatórios" ], "summary": "Listar configuração", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-config", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" }, "put": { "tags": [ "Relatórios" ], "summary": "Substituir configuração", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "put-sentinel-config", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "churnThreshold": { "type": "number" }, "revenueSignalEnabled": { "type": "boolean" }, "patternDetectionEnabled": { "type": "boolean" }, "copilotEnabled": { "type": "boolean" }, "predictiveSlaEnabled": { "type": "boolean" }, "briefingEnabled": { "type": "boolean" }, "briefingEmail": {}, "briefingTime": {}, "analysisModel": { "type": "string" } }, "required": [ "briefingEmail", "briefingTime" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/conversations/{conversationId}": { "get": { "tags": [ "Relatórios" ], "summary": "Consultar conversas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-conversations-conversationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de conversa." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/cross-channel": { "get": { "tags": [ "Relatórios" ], "summary": "Listar cross channel", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-cross-channel", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" }, "post": { "tags": [ "Relatórios" ], "summary": "Criar ou executar cross channel", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "post-sentinel-cross-channel", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/health": { "get": { "tags": [ "Relatórios" ], "summary": "Listar health", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-health", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/overview": { "get": { "tags": [ "Relatórios" ], "summary": "Listar overview", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-overview", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/patterns": { "get": { "tags": [ "Relatórios" ], "summary": "Listar patterns", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-patterns", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/patterns/{patternId}": { "get": { "tags": [ "Relatórios" ], "summary": "Consultar patterns", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-patterns-patternId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "patternId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de padrão." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/predictive-sla": { "get": { "tags": [ "Relatórios" ], "summary": "Listar predictive sla", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-predictive-sla", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/predictive-sla/{conversationId}": { "get": { "tags": [ "Relatórios" ], "summary": "Consultar predictive sla", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-predictive-sla-conversationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de conversa." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/recommendations": { "get": { "tags": [ "Relatórios" ], "summary": "Listar recommendations", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-recommendations", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/sentinel/recommendations/{recommendationId}": { "patch": { "tags": [ "Relatórios" ], "summary": "Atualizar recommendations", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:write`.", "operationId": "patch-sentinel-recommendations-recommendationId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "recommendationId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de recomendação." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ACCEPTED", "DISMISSED" ] }, "outcome": { "type": "string", "nullable": true }, "execute": { "type": "boolean" }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:write" } }, "/api/sentinel/scores": { "get": { "tags": [ "Relatórios" ], "summary": "Listar scores", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `reports:read`.", "operationId": "get-sentinel-scores", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "reports:read" } }, "/api/settings/contacts": { "get": { "tags": [ "Configurações" ], "summary": "Listar contacts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-contacts", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar contacts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-settings-contacts", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "MERGED", "SPLIT" ] }, "strategy": { "type": "string", "enum": [ "KEEP_ALL", "DELETE_NOT_IN_CREDENTIAL", "ASSIGN_UNLINKED_TO_CREDENTIAL" ] }, "credentialId": { "type": "string" } }, "required": [ "mode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "202": { "description": "Operação aceita para processamento.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/settings/contacts/jobs/{jobId}": { "get": { "tags": [ "Configurações" ], "summary": "Consultar jobs", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-contacts-jobs-jobId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de processamento." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" } }, "/api/settings/flow-encryption": { "get": { "tags": [ "Configurações" ], "summary": "Listar flow encryption", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-flow-encryption", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar flow encryption", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-settings-flow-encryption", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir flow encryption", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-settings-flow-encryption", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/settings/privacy": { "get": { "tags": [ "Configurações" ], "summary": "Listar privacy", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-privacy", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar privacy", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-settings-privacy", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "sendReadReceipts": { "type": "boolean" }, "sendTypingIndicators": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/settings/satisfaction": { "get": { "tags": [ "Configurações" ], "summary": "Listar satisfaction", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-satisfaction", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar satisfaction", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-settings-satisfaction", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "isEnabled": { "type": "boolean" }, "delayMinutes": { "type": "number" }, "messageMode": { "type": "string", "enum": [ "BUTTONS", "LIST", "TEXT", "TEMPLATE" ] }, "questionText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true }, "listButtonText": { "type": "string", "nullable": true }, "templateId": { "type": "string", "nullable": true }, "responseOptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "score": { "type": "number" }, "aliases": { "type": "array", "items": { "type": "string" } } }, "required": [ "label", "score" ], "additionalProperties": false } }, "lowScoreThreshold": { "type": "number" }, "reopenOnLowScore": { "type": "boolean" } }, "required": [ "credentialId", "messageMode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir satisfaction", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-settings-satisfaction", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" } }, "required": [ "credentialId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/settings/satisfaction/surveys/{id}": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar surveys", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-settings-satisfaction-surveys-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "action": { "type": "string", "enum": [ "cancel", "retry" ] } }, "required": [ "credentialId", "action" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/settings/sla": { "get": { "tags": [ "SLA" ], "summary": "Listar sla", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:read`.", "operationId": "get-settings-sla", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "sla:read" }, "post": { "tags": [ "SLA" ], "summary": "Criar ou executar sla", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:write`.", "operationId": "post-settings-sla", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "firstResponseEnabled": { "type": "boolean" }, "firstResponseThreshold": { "type": "number" }, "resolutionEnabled": { "type": "boolean" }, "resolutionThreshold": { "type": "number" }, "warningThresholdPercent": { "type": "number" }, "isActive": { "type": "boolean" }, "notifyEmail": { "type": "boolean" }, "notifyBrowser": { "type": "boolean" }, "notifyVisual": { "type": "boolean" }, "notifyAudio": { "type": "boolean" }, "autoPrivateMessage": { "type": "boolean" }, "privateMessageTemplate": { "type": "string", "nullable": true }, "emailRecipientUserIds": { "type": "array", "items": { "type": "string" } }, "escalationEnabled": { "type": "boolean" }, "escalationAfterMinutes": { "type": "number" }, "escalationTargetUserId": { "type": "string", "nullable": true }, "escalationTargetTeamId": { "type": "string", "nullable": true }, "escalationTargetAIAgentId": { "type": "string", "nullable": true }, "escalationAiFallbackAfterMinutes": { "type": "number" }, "aiEscalationPrompt": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "contactResponseEnabled": { "type": "boolean" }, "contactResponseThreshold": { "type": "number" }, "businessHoursEnabled": { "type": "boolean" }, "businessHours": { "type": "object", "properties": { "days": { "type": "object", "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "enabled", "start", "end" ], "additionalProperties": false } } }, "required": [ "days" ], "additionalProperties": false, "nullable": true } }, "required": [ "credentialId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "sla:write" }, "delete": { "tags": [ "SLA" ], "summary": "Excluir sla", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:write`.", "operationId": "delete-settings-sla", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" } }, "required": [ "credentialId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "sla:write" } }, "/api/settings/sla/eligible-ai-agents": { "get": { "tags": [ "SLA" ], "summary": "Listar eligible ai agents", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `sla:read`.", "operationId": "get-settings-sla-eligible-ai-agents", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "sla:read" } }, "/api/settings/template-ai": { "get": { "tags": [ "Configurações" ], "summary": "Listar template ai", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-settings-template-ai", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar template ai", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-settings-template-ai", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "providerKeyId": { "type": "string", "nullable": true }, "model": { "type": "string", "nullable": true } }, "required": [ "enabled" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/shortcuts": { "get": { "tags": [ "Configurações" ], "summary": "Listar shortcuts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-shortcuts", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar shortcuts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "post-shortcuts", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PAGE", "CONVERSATION", "ORDER", "CONTACT", "TEMPLATE", "AUTOMATION", "CONNECTOR", "CUSTOM" ], "default": "PAGE" }, "label": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "href": { "type": "string" }, "category": { "type": "string", "default": "general" }, "pinned": { "type": "boolean", "default": false }, "keybinding": { "type": "string", "nullable": true } }, "required": [ "type", "label", "href", "category", "pinned" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" } }, "/api/shortcuts/{id}": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar shortcuts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "patch-shortcuts-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "href": { "type": "string" }, "category": { "type": "string" }, "pinned": { "type": "boolean" }, "keybinding": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir shortcuts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "delete-shortcuts-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" } }, "/api/shortcuts/reorder": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar reorder", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "patch-shortcuts-reorder", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "ids" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" } }, "/api/tags": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Listar tags", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-tags", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "search", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Texto usado na busca." }, { "name": "strictCredential", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de strict credential." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "post": { "tags": [ "Contatos e CRM" ], "summary": "Criar ou executar tags", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "post-tags", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "required": [ "name", "color" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/tags/{tagId}": { "get": { "tags": [ "Contatos e CRM" ], "summary": "Consultar tags", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:read`.", "operationId": "get-tags-tagId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de tag." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:read" }, "patch": { "tags": [ "Contatos e CRM" ], "summary": "Atualizar tags", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "patch-tags-tagId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de tag." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" }, "delete": { "tags": [ "Contatos e CRM" ], "summary": "Excluir tags", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `contacts:write`.", "operationId": "delete-tags-tagId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de tag." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "contacts:write" } }, "/api/task-groups": { "get": { "tags": [ "Tarefas" ], "summary": "Listar grupos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-task-groups", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "post": { "tags": [ "Tarefas" ], "summary": "Criar ou executar grupos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "post-task-groups", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "projectId": { "type": "string" }, "order": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-groups/{id}": { "patch": { "tags": [ "Tarefas" ], "summary": "Atualizar grupos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "patch-task-groups-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "projectId": { "type": "string", "nullable": true }, "order": { "type": "number" }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" }, "delete": { "tags": [ "Tarefas" ], "summary": "Excluir grupos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "delete-task-groups-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-labels": { "get": { "tags": [ "Tarefas" ], "summary": "Listar etiquetas de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-task-labels", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "post": { "tags": [ "Tarefas" ], "summary": "Criar ou executar etiquetas de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "post-task-labels", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-labels/{id}": { "patch": { "tags": [ "Tarefas" ], "summary": "Atualizar etiquetas de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "patch-task-labels-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" }, "delete": { "tags": [ "Tarefas" ], "summary": "Excluir etiquetas de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "delete-task-labels-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-projects": { "get": { "tags": [ "Tarefas" ], "summary": "Listar projetos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-task-projects", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "post": { "tags": [ "Tarefas" ], "summary": "Criar ou executar projetos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "post-task-projects", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-projects/{id}": { "patch": { "tags": [ "Tarefas" ], "summary": "Atualizar projetos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "patch-task-projects-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" }, "delete": { "tags": [ "Tarefas" ], "summary": "Excluir projetos de tarefas", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "delete-task-projects-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-schedules": { "get": { "tags": [ "Tarefas" ], "summary": "Listar task schedules", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-task-schedules", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "post": { "tags": [ "Tarefas" ], "summary": "Criar ou executar task schedules", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "post-task-schedules", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "totalWeeks": { "type": "number", "default": "4" }, "repeatCycle": { "type": "boolean", "default": true }, "cycleDurationMonths": { "type": "number", "nullable": true }, "startDate": { "type": "string" }, "projectId": { "type": "string" }, "assignedToId": { "type": "string" }, "assignedTeamId": { "type": "string" }, "channelAccountId": { "type": "string" }, "credentialId": { "type": "string" }, "contactId": { "type": "string", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {} }, "entries": { "type": "array", "items": { "type": "object", "properties": { "weekNumber": { "type": "number" }, "dayOfWeek": { "type": "number" }, "timeOfDay": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "string", "enum": [ "LOW", "NORMAL", "HIGH", "URGENT" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "groupId": { "type": "string" }, "estimatedMinutes": { "type": "number" } }, "required": [ "weekNumber", "dayOfWeek", "timeOfDay", "title" ], "additionalProperties": false } } }, "required": [ "name", "totalWeeks", "repeatCycle", "startDate", "entries" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/task-schedules/{id}": { "get": { "tags": [ "Tarefas" ], "summary": "Consultar task schedules", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-task-schedules-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "patch": { "tags": [ "Tarefas" ], "summary": "Atualizar task schedules", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "patch-task-schedules-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "totalWeeks": { "type": "number" }, "repeatCycle": { "type": "boolean" }, "cycleDurationMonths": { "type": "number", "nullable": true }, "startDate": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "PAUSED", "ARCHIVED" ] }, "projectId": { "type": "string", "nullable": true }, "contactId": { "type": "string", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "assignedToId": { "type": "string", "nullable": true }, "assignedTeamId": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "weekNumber": { "type": "number" }, "dayOfWeek": { "type": "number" }, "timeOfDay": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "priority": { "type": "string", "enum": [ "LOW", "NORMAL", "HIGH", "URGENT" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "groupId": { "type": "string", "nullable": true }, "estimatedMinutes": { "type": "number" } }, "required": [ "weekNumber", "dayOfWeek", "timeOfDay", "title" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" }, "delete": { "tags": [ "Tarefas" ], "summary": "Excluir task schedules", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "delete-task-schedules-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "generatedTasksAction": { "type": "string", "enum": [ "keep", "delete" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/tasks": { "get": { "tags": [ "Tarefas" ], "summary": "Listar tasks", "description": "Lista tarefas com filtros por contato, projeto, grupo, status e texto.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-tasks", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Conta compatível usada para resolver o escopo" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Limite máximo de itens retornados." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Página da listagem, iniciando em 1." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "post": { "tags": [ "Tarefas" ], "summary": "Criar ou executar tasks", "description": "Cria uma tarefa no escopo da conta selecionada. Se não houver `contactId`, informe uma forma de atribuição, como `assignToSelf`.\n\nExemplo de criação com evento no Google Calendar. Exige conector ativo e calendário configurado.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "post-tasks", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "credentialId": {}, "projectId": {}, "groupId": {}, "labels": { "type": "array", "items": {} }, "status": { "type": "string" }, "priority": { "type": "string" }, "dueDate": { "type": "string" }, "assignToSelf": { "type": "boolean" }, "contactId": { "type": "string", "nullable": true }, "contactIds": { "type": "array", "items": {} }, "channelAccountId": {}, "crmDealId": { "nullable": true }, "conversationId": {}, "assignedToId": {}, "assignedTeamId": {}, "googleCalendar": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "google", "microsoft" ] }, "includeDetails": { "type": "boolean" }, "calendarId": { "type": "string", "nullable": true }, "addVideoConference": { "type": "boolean" }, "addContactAsAttendee": { "type": "boolean" }, "additionalEmails": { "type": "array", "items": { "type": "string" } }, "sendInvites": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, "required": [ "title" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Task", "value": { "title": "Tarefa criada via API", "description": "Acompanhar cliente e registrar retorno.", "credentialId": "{{credentialId}}", "projectId": "{{projectId}}", "groupId": "{{groupId}}", "labels": [], "status": "TODO", "priority": "HIGH", "dueDate": "2026-01-20T15:00:00.000Z", "assignToSelf": true } }, "exemplo2": { "summary": "Create Task with Google Calendar", "value": { "title": "Reunião com cliente", "description": "Reunião comercial criada pela API.", "credentialId": "{{credentialId}}", "contactId": "{{contactId}}", "assignToSelf": true, "dueDate": "2026-01-21T14:00:00.000Z", "googleCalendar": { "enabled": true, "provider": "google", "includeDetails": true, "calendarId": "{{calendarId}}", "addVideoConference": true, "sendInvites": true } } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/tasks/{id}": { "get": { "tags": [ "Tarefas" ], "summary": "Consultar tasks", "description": "Busca uma tarefa específica.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-tasks-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" }, "patch": { "tags": [ "Tarefas" ], "summary": "Atualizar tasks", "description": "Atualiza os principais campos da tarefa. A rota também pode sincronizar o evento de calendário quando necessário.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "patch-tasks-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "priority": { "type": "string" }, "assignedToId": { "nullable": true }, "assignedTeamId": { "nullable": true }, "channelAccountId": { "type": "string" }, "credentialId": {}, "projectId": { "nullable": true }, "groupId": { "nullable": true }, "crmDealId": { "nullable": true }, "labels": { "type": "array", "items": {} }, "dueDate": { "type": "string", "nullable": true }, "contactId": { "nullable": true }, "contactIds": { "type": "array", "items": {} }, "googleCalendar": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "google", "microsoft" ] }, "includeDetails": { "type": "boolean" }, "calendarId": { "type": "string", "nullable": true }, "addVideoConference": { "type": "boolean" }, "addContactAsAttendee": { "type": "boolean" }, "additionalEmails": { "type": "array", "items": { "type": "string" } }, "sendInvites": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Task", "value": { "title": "Tarefa atualizada via API", "description": "Cliente respondeu, seguir para próxima etapa.", "status": "IN_PROGRESS", "priority": "URGENT", "assignedToId": null, "assignedTeamId": null } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" }, "delete": { "tags": [ "Tarefas" ], "summary": "Excluir tasks", "description": "Exclui a tarefa informada e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:write`.", "operationId": "delete-tasks-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:write" } }, "/api/tasks/metadata": { "get": { "tags": [ "Tarefas" ], "summary": "Listar metadata", "description": "Retorna projetos, etiquetas, grupos e a capacidade de atribuir a outras pessoas no escopo atual.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `tasks:read`.", "operationId": "get-tasks-metadata", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "channelAccountId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de channel account." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "tasks:read" } }, "/api/team/invite": { "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar invite", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-team-invite", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "ADMIN", "AGENT" ] }, "credentialIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "email", "role" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/team/users/{userId}": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar usuários", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-team-users-userId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de usuário." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "ADMIN", "AGENT" ] }, "isActive": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir usuários", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-team-users-userId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de usuário." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/team/users/{userId}/permissions": { "get": { "tags": [ "Configurações" ], "summary": "Listar permissions", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-team-users-userId-permissions", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de usuário." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "put": { "tags": [ "Configurações" ], "summary": "Substituir permissions", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "put-team-users-userId-permissions", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de usuário." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "permissions": {} }, "required": [ "permissions" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir permissions", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-team-users-userId-permissions", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de usuário." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/teams": { "get": { "tags": [ "Configurações" ], "summary": "Listar equipes", "description": "Lista as equipes ativas do ambiente.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-teams", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de include inactive." }, { "name": "includeMembers", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Quando true, inclui membros e contagens na resposta" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Texto usado na busca." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar equipes", "description": "Cria uma nova equipe. Requer OWNER ou ADMIN.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-teams", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": {}, "color": { "type": "string" } }, "required": [ "name", "description" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Team", "value": { "name": "Equipe API", "description": "Equipe criada para testar a API pública.", "color": "#6366f1" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/teams/{teamId}": { "get": { "tags": [ "Configurações" ], "summary": "Consultar equipes", "description": "Retorna uma equipe específica com membros e quantidade de atribuições.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-teams-teamId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar equipes", "description": "Atualiza nome, descrição, cor e estado ativo da equipe. Requer OWNER ou ADMIN.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-teams-teamId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": {}, "color": { "type": "string" }, "isActive": { "type": "boolean" } }, "required": [ "description" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Team", "value": { "name": "Equipe API Atualizada", "description": "Equipe revisada pela API.", "color": "#8b5cf6", "isActive": true } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir equipes", "description": "Exclui a equipe informada. Falha se ainda houver conversas atribuídas a ela.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-teams-teamId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/teams/{teamId}/members": { "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar membros", "description": "Adiciona uma pessoa à equipe. O papel pode ser `LEAD` ou `MEMBER`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-teams-teamId-members", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "role": { "type": "string", "enum": [ "LEAD", "MEMBER" ], "default": "MEMBER" } }, "required": [ "userId", "role" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Add Team Member", "value": { "userId": "{{userId}}", "role": "MEMBER" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir membros", "description": "Remove a pessoa informada da equipe e retorna `{ success: true }`.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-teams-teamId-members", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de user." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar membros", "description": "Atualiza o papel de uma pessoa já vinculada à equipe.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-teams-teamId-members", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de equipe." }, { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Usuário cujo papel será atualizado" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "LEAD", "MEMBER" ] } }, "required": [ "role" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Team Member Role", "value": { "role": "LEAD" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/templates": { "get": { "tags": [ "Templates" ], "summary": "Listar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" }, "description": "Valor opcional de after." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de force." }, { "name": "fullSync", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de full sync." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100 }, "description": "Limite máximo de itens retornados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "MARKETING", "UTILITY", "AUTHENTICATION" ] }, "templateType": { "type": "string", "enum": [ "STANDARD", "CATALOG", "MARKETING_FLOW", "ORDER_DETAILS", "CALL_PERMISSION", "UTILITY_STANDARD", "UTILITY_FLOW", "ORDER_STATUS", "UTILITY_ORDER_DETAILS", "UTILITY_CALL_PERMISSION", "OTP" ] }, "language": { "type": "string" }, "components": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "HEADER" }, "format": { "type": "string", "enum": [ "TEXT", "IMAGE", "VIDEO", "DOCUMENT", "LOCATION" ] }, "text": { "type": "string" }, "example": { "type": "object", "properties": { "header_handle": { "type": "array", "items": { "type": "string" } }, "header_text": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "required": [ "type", "format" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "BODY" }, "text": { "type": "string" }, "example": { "type": "object", "properties": { "body_text": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": false } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "FOOTER" }, "text": { "type": "string" } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "BUTTONS" }, "buttons": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "QUICK_REPLY" }, "text": { "type": "string" } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "URL" }, "text": { "type": "string" }, "url": { "type": "string" }, "example": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "text", "url" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "PHONE_NUMBER" }, "text": { "type": "string" }, "phone_number": { "type": "string" } }, "required": [ "type", "text", "phone_number" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "FLOW" }, "text": { "type": "string" }, "flow_id": { "type": "string" }, "flow_json": { "type": "string" }, "navigate_screen": { "type": "string" }, "flow_action": { "type": "string", "enum": [ "navigate" ] } }, "required": [ "type", "text" ], "additionalProperties": false } ] } } }, "required": [ "type" ], "additionalProperties": false }, { "type": "object", "additionalProperties": {} } ] } }, "allowCategoryChange": { "type": "boolean" }, "linkedFlowId": { "type": "string" }, "flowButtonText": { "type": "string" }, "flowNavigateScreen": { "type": "string" } }, "required": [ "credentialId", "name", "category", "language", "components" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/{id}": { "patch": { "tags": [ "Templates" ], "summary": "Atualizar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "patch-templates-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "nullable": true }, "subGroupId": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "delete-templates-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/cleanup-unused": { "get": { "tags": [ "Templates" ], "summary": "Limpar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-cleanup-unused", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "post": { "tags": [ "Templates" ], "summary": "Limpar templates", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-cleanup-unused", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inactiveDays": { "anyOf": [ { "const": "30" }, { "const": "60" }, { "const": "90" } ] }, "credentialId": { "type": "string", "nullable": true } }, "required": [ "inactiveDays" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Resposta da operação.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/drafts": { "get": { "tags": [ "Templates" ], "summary": "Listar drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-drafts", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 12 }, "description": "Limite máximo de itens retornados." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "delete-templates-drafts", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "nullable": true }, "credentialId": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-drafts", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "additionalProperties": {} }, "credentialId": { "type": "string", "nullable": true }, "conversationId": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true } }, "required": [ "payload" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/drafts/{draftId}": { "get": { "tags": [ "Templates" ], "summary": "Consultar drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-drafts-draftId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de draft." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "patch": { "tags": [ "Templates" ], "summary": "Atualizar drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "patch-templates-drafts-draftId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de draft." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "object", "additionalProperties": {} }, "credentialId": { "type": "string", "nullable": true }, "conversationId": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true } }, "required": [ "payload" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir drafts", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "delete-templates-drafts-draftId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de draft." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/favorites": { "get": { "tags": [ "Templates" ], "summary": "Listar favorites", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-favorites", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar favorites", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "post-templates-favorites", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" } }, "required": [ "templateId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir favorites", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "delete-templates-favorites", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" } }, "required": [ "templateId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" } }, "/api/templates/generate": { "post": { "tags": [ "Templates" ], "summary": "Criar ou executar generate", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-generate", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "prompt": { "type": "string", "nullable": true }, "presetId": { "type": "string", "nullable": true }, "category": { "type": "string", "enum": [ "UTILITY", "MARKETING", "AUTHENTICATION" ], "nullable": true }, "language": { "type": "string", "nullable": true }, "consultConversation": { "type": "boolean", "default": false }, "conversationId": { "type": "string", "nullable": true } }, "required": [ "credentialId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/groups": { "get": { "tags": [ "Templates" ], "summary": "Listar groups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-groups", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar groups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-groups", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isActive": { "type": "boolean" } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/groups/{groupId}": { "patch": { "tags": [ "Templates" ], "summary": "Atualizar groups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "patch-templates-groups-groupId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de group." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isActive": { "type": "boolean" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir groups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "delete-templates-groups-groupId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de group." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/link-flow": { "post": { "tags": [ "Templates" ], "summary": "Criar ou executar link flow", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-link-flow", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" }, "flowId": { "type": "string", "nullable": true } }, "required": [ "templateId", "flowId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "get": { "tags": [ "Templates" ], "summary": "Listar link flow", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-link-flow", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "flowId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de flow." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" } }, "/api/templates/list": { "get": { "tags": [ "Templates" ], "summary": "Listar list", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-list", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." }, { "name": "favorites", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Valor opcional de favorites." }, { "name": "groupId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de group." }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Status usado para filtrar os resultados." }, { "name": "subGroupId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de sub group." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" } }, "/api/templates/media-handle": { "post": { "tags": [ "Templates" ], "summary": "Criar ou executar media handle", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-media-handle", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/organization-plan": { "get": { "tags": [ "Templates" ], "summary": "Listar organization plan", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "get-templates-organization-plan", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "credentialId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "ID da conta conectada no escopo da chave." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar organization plan", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-organization-plan", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" } }, "required": [ "credentialId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/organization-plan/{planId}": { "patch": { "tags": [ "Templates" ], "summary": "Atualizar organization plan", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "patch-templates-organization-plan-planId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de plan." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "approve", "cancel" ] } }, "required": [ "action" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/subgroups": { "get": { "tags": [ "Templates" ], "summary": "Listar subgroups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:read`.", "operationId": "get-templates-subgroups", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "groupId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de group." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:read" }, "post": { "tags": [ "Templates" ], "summary": "Criar ou executar subgroups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "post-templates-subgroups", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isActive": { "type": "boolean" } }, "required": [ "groupId", "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/templates/subgroups/{subGroupId}": { "patch": { "tags": [ "Templates" ], "summary": "Atualizar subgroups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "patch-templates-subgroups-subGroupId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "subGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de sub group." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "order": { "type": "number" }, "isActive": { "type": "boolean" }, "groupId": { "type": "string" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflito com o estado atual do recurso.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" }, "delete": { "tags": [ "Templates" ], "summary": "Excluir subgroups", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `templates:write`.", "operationId": "delete-templates-subgroups-subGroupId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "subGroupId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de sub group." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "templates:write" } }, "/api/tenant/update": { "patch": { "tags": [ "Configurações" ], "summary": "Atualizar update", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-tenant-update", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/webhooks/test/data/{sessionId}": { "get": { "tags": [ "Conectores" ], "summary": "Consultar data", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.", "operationId": "get-webhooks-test-data-sessionId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de sessão." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "connectors:read" } }, "/api/webhooks/test/events/{sessionId}": { "get": { "tags": [ "Conectores" ], "summary": "Consultar eventos", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:read`.", "operationId": "get-webhooks-test-events-sessionId", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de sessão." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "connectors:read" } }, "/api/webhooks/test/start": { "post": { "tags": [ "Conectores" ], "summary": "Iniciar test", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.", "operationId": "post-webhooks-test-start", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "connectors:write" } }, "/api/webhooks/test/stop": { "post": { "tags": [ "Conectores" ], "summary": "Interromper test", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `connectors:write`.", "operationId": "post-webhooks-test-stop", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "connectors:write" } }, "/api/widget-campaigns": { "get": { "tags": [ "Disparos" ], "summary": "Listar campanhas do widget", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-widget-campaigns", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "widgetConfigId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de widget config." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "post": { "tags": [ "Disparos" ], "summary": "Criar ou executar campanhas do widget", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "post-widget-campaigns", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "widgetConfigId": { "type": "string" }, "name": { "type": "string" }, "message": { "type": "string" }, "messageType": { "type": "string", "enum": [ "TEXT", "INTERACTIVE" ] }, "interactive": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "buttons", "list", "cards" ] }, "header": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "image", "video", "document" ] }, "text": { "type": "string", "nullable": true }, "image": { "type": "object", "properties": { "link": { "type": "string" }, "caption": { "type": "string", "nullable": true } }, "required": [ "link" ], "additionalProperties": false, "nullable": true }, "video": { "type": "object", "properties": { "link": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false, "nullable": true }, "document": { "type": "object", "properties": { "link": { "type": "string" }, "filename": { "type": "string", "nullable": true } }, "required": [ "link" ], "additionalProperties": false, "nullable": true } }, "required": [ "type" ], "additionalProperties": false, "nullable": true }, "body": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false, "nullable": true }, "footer": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false, "nullable": true }, "action": { "type": "object", "properties": { "buttons": { "type": "array", "items": { "type": "object", "properties": { "reply": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "required": [ "reply" ], "additionalProperties": false }, "nullable": true }, "sections": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "additionalProperties": false }, "nullable": true } }, "additionalProperties": false, "nullable": true }, "cards": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "actions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "link", "postback" ] }, "text": { "type": "string" }, "uri": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true } }, "required": [ "type", "text" ], "additionalProperties": false }, "nullable": true } }, "required": [ "title" ], "additionalProperties": false }, "nullable": true } }, "required": [ "type", "action" ], "additionalProperties": false, "nullable": true }, "urlPatterns": { "type": "array", "items": { "type": "string" } }, "timeOnPageSeconds": { "type": "number" }, "sentBy": { "type": "string", "enum": [ "agent", "bot" ], "nullable": true }, "businessHours": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "start": { "type": "string", "nullable": true }, "end": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false, "nullable": true }, "isActive": { "type": "boolean" } }, "required": [ "widgetConfigId", "name", "message", "urlPatterns", "businessHours" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Dados semanticamente inválidos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/widget-campaigns/{id}": { "get": { "tags": [ "Disparos" ], "summary": "Consultar campanhas do widget", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:read`.", "operationId": "get-widget-campaigns-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:read" }, "patch": { "tags": [ "Disparos" ], "summary": "Atualizar campanhas do widget", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "patch-widget-campaigns-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "widgetConfigId": { "type": "string" }, "name": { "type": "string" }, "message": { "type": "string" }, "messageType": { "type": "string", "enum": [ "TEXT", "INTERACTIVE" ] }, "interactive": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "buttons", "list", "cards" ] }, "header": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "image", "video", "document" ] }, "text": { "type": "string", "nullable": true }, "image": { "type": "object", "properties": { "link": { "type": "string" }, "caption": { "type": "string", "nullable": true } }, "required": [ "link" ], "additionalProperties": false, "nullable": true }, "video": { "type": "object", "properties": { "link": { "type": "string" } }, "required": [ "link" ], "additionalProperties": false, "nullable": true }, "document": { "type": "object", "properties": { "link": { "type": "string" }, "filename": { "type": "string", "nullable": true } }, "required": [ "link" ], "additionalProperties": false, "nullable": true } }, "required": [ "type" ], "additionalProperties": false, "nullable": true }, "body": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false, "nullable": true }, "footer": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ], "additionalProperties": false, "nullable": true }, "action": { "type": "object", "properties": { "buttons": { "type": "array", "items": { "type": "object", "properties": { "reply": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "required": [ "reply" ], "additionalProperties": false }, "nullable": true }, "sections": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "additionalProperties": false }, "nullable": true } }, "additionalProperties": false, "nullable": true }, "cards": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "actions": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "link", "postback" ] }, "text": { "type": "string" }, "uri": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true } }, "required": [ "type", "text" ], "additionalProperties": false }, "nullable": true } }, "required": [ "title" ], "additionalProperties": false }, "nullable": true } }, "required": [ "type", "action" ], "additionalProperties": false, "nullable": true }, "urlPatterns": { "type": "array", "items": { "type": "string" } }, "timeOnPageSeconds": { "type": "number" }, "sentBy": { "type": "string", "enum": [ "agent", "bot" ], "nullable": true }, "businessHours": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "start": { "type": "string", "nullable": true }, "end": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false, "nullable": true }, "isActive": { "type": "boolean" } }, "required": [ "widgetConfigId", "name", "message", "urlPatterns", "businessHours" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Dados semanticamente inválidos.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" }, "delete": { "tags": [ "Disparos" ], "summary": "Excluir campanhas do widget", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `broadcasts:write`.", "operationId": "delete-widget-campaigns-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "broadcasts:write" } }, "/api/widgets/configs": { "get": { "tags": [ "Configurações" ], "summary": "Listar configs", "description": "Lista as configurações de widget disponíveis.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-widgets-configs", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar configs", "description": "Cria uma nova configuração de widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-widgets-configs", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "theme": { "type": "object", "additionalProperties": {}, "nullable": true }, "welcomeTitle": { "type": "string", "nullable": true }, "welcomeMessage": { "type": "string", "nullable": true }, "allowGuestMessages": { "type": "boolean" }, "requirePreChatForm": { "type": "boolean" }, "preChatForm": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "submitLabel": { "type": "string", "nullable": true }, "successMessage": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "email", "phone", "textarea", "select" ] }, "required": { "type": "boolean", "default": false }, "placeholder": { "type": "string", "nullable": true }, "helperText": { "type": "string", "nullable": true }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ], "additionalProperties": false }, "nullable": true }, "mapTo": { "type": "string", "enum": [ "name", "email", "phone", "customAttribute" ] }, "customAttributeKey": { "type": "string", "nullable": true } }, "required": [ "id", "label", "type" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false, "nullable": true }, "defaultTags": { "type": "array", "items": { "type": "string" } }, "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "credentialId", "name" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Widget Config", "value": { "credentialId": "{{credentialId}}", "name": "Widget API", "slug": "widget-api", "description": "Configuração criada pela API.", "isActive": true, "theme": { "primaryColor": "#6366f1" }, "welcomeTitle": "Olá!", "welcomeMessage": "Como podemos ajudar?" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/widgets/configs/{id}": { "get": { "tags": [ "Configurações" ], "summary": "Consultar configs", "description": "Busca uma configuração específica do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-widgets-configs-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar configs", "description": "Atualiza uma configuração existente do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-widgets-configs-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "welcomeTitle": { "type": "string", "nullable": true }, "welcomeMessage": { "type": "string", "nullable": true }, "credentialId": { "type": "string" }, "slug": { "type": "string", "nullable": true }, "allowGuestMessages": { "type": "boolean" }, "requirePreChatForm": { "type": "boolean" }, "preChatForm": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "submitLabel": { "type": "string", "nullable": true }, "successMessage": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "email", "phone", "textarea", "select" ] }, "required": { "type": "boolean", "default": false }, "placeholder": { "type": "string", "nullable": true }, "helperText": { "type": "string", "nullable": true }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ], "additionalProperties": false }, "nullable": true }, "mapTo": { "type": "string", "enum": [ "name", "email", "phone", "customAttribute" ] }, "customAttributeKey": { "type": "string", "nullable": true } }, "required": [ "id", "label", "type" ], "additionalProperties": false } } }, "required": [ "fields" ], "additionalProperties": false, "nullable": true }, "defaultTags": { "type": "array", "items": { "type": "string" } }, "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "theme": { "type": "object", "additionalProperties": {}, "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "required": [ "credentialId", "name" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Widget Config", "value": { "name": "Widget API Atualizado", "description": "Configuração atualizada pela API.", "isActive": true, "welcomeTitle": "Bem-vindo!", "welcomeMessage": "Estamos online para te atender." } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir configs", "description": "Exclui a configuração do widget e seus dados associados.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-widgets-configs-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/widgets/configs/{id}/avatar": { "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar avatar", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-widgets-configs-id-avatar", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "additionalProperties": true } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "Requisição inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir avatar", "description": "Opera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-widgets-configs-id-avatar", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/widgets/tokens": { "get": { "tags": [ "Configurações" ], "summary": "Listar tokens", "description": "Lista os tokens de acesso ligados a uma configuração de widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-widgets-tokens", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "widgetConfigId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Valor opcional de widget config." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "post": { "tags": [ "Configurações" ], "summary": "Criar ou executar tokens", "description": "Cria um token de acesso para uso do widget/SDK.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "post-widgets-tokens", "security": [ { "bearerAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "widgetConfigId": { "type": "string" }, "name": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "widget:read", "widget:send" ] } }, "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true }, "isActive": { "type": "boolean" } }, "required": [ "widgetConfigId" ], "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Create Widget Token", "value": { "widgetConfigId": "{{widgetConfigId}}", "name": "Token API", "scopes": [ "widget:read", "widget:write" ], "allowedOrigins": [ "https://example.com" ], "expiresAt": "2026-12-31T23:59:59.999Z" } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "201": { "description": "Recurso criado com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } }, "/api/widgets/tokens/{id}": { "get": { "tags": [ "Configurações" ], "summary": "Consultar tokens", "description": "Busca um token específico. O segredo costuma vir mascarado na resposta.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:read`.", "operationId": "get-widgets-tokens-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:read" }, "patch": { "tags": [ "Configurações" ], "summary": "Atualizar tokens", "description": "Atualiza metadados e permissões do token.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "patch-widgets-tokens-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "widget:read", "widget:send" ] } }, "allowedOrigins": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "expiresAt": { "type": "string", "nullable": true }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false }, "examples": { "exemplo1": { "summary": "Update Widget Token", "value": { "name": "Token API Atualizado", "scopes": [ "widget:read" ], "allowedOrigins": [ "https://example.com" ], "isActive": true } } } } } }, "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" }, "delete": { "tags": [ "Configurações" ], "summary": "Excluir tokens", "description": "Revoga ou exclui um token do widget.\n\nOpera no escopo da conta vinculada à chave de API. Requer a permissão `settings:write`.", "operationId": "delete-widgets-tokens-id", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identificador de id." }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Use soft para revogar sem apagar definitivamente" } ], "responses": { "200": { "description": "Operação concluída com sucesso.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "401": { "description": "Chave de API ausente ou inválida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "A chave não possui a permissão ou o acesso necessários.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Erro interno inesperado.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-api-permission": "settings:write" } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "wcp_...", "description": "Chave criada em Configurações > Chaves de API." } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": [ "object", "array", "string", "null" ] } } } } }, "security": [ { "bearerAuth": [] } ], "x-documentation": { "route": "/docs/api", "source": "handlers-and-validators", "operationCount": 668, "sessionOnlyOperationCount": 75, "legacyPostmanRequestCount": 218 } }