API Marketing/Editor — modelos, campanhas, peças e captação

Referência de Marketing/Editor para integrar as operações descritas abaixo.

Guia principal e downloads · Exemplos · Endpoints

Índice clicável

Landing pages — LandingPage · Campanhas de e-mail — CampanhaEmail · Conexão Meta, captação e publicação social — EditorSocial · Edição de documentos Office — EditorOnlyOffice · Planejamento do Estúdio — EditorEstudioBriefing · Assistente do Editor — EditorBedrockAgent · Geração de imagens — EditorBedrockImage · Modelos de proposta — ModeloPreProposta · Modelos de documento — ModeloDocumento · Modelos de e-mail — ModeloEmail · Identidades de remetente — IdentidadeRemetente · E-mails enviados — EmailEnviado · Eventos de entrega de e-mail — EmailEvento · Integração Meta — Meta · Configuração Meta — ConfiguracaoMeta

Como usar esta referência

API central: https://{tenant}.api.groner.app. Use API_URL com o host da empresa, sem /api. Envie Bearer. O middleware retorna o envelope Content; tabelas avançadas, downloads e 204 possuem transporte próprio. A operação e a função do usuário determinam o acesso.

Substitua tenant/token pelo ambiente autorizado e IDs de exemplo pelos cadastros reais. Os comandos são Bash; no PowerShell use curl.exe e adapte variáveis e continuação de linha.

Recursos compartilhados: a organização segue a finalidade principal da operação, não exclusividade de produto. Um client consumir um controller não significa que todas as actions desse controller sejam liberadas para aquele usuário. Consulte guard e contrato.

Dois fluxos de Editor: modelos de documentos/propostas e Estúdio/Marketing. Edição de modelo não é emissão de proposta de um negócio. Captação Meta integra o CRM, sem mudar a identidade do contato.

Exemplos de requisição e resposta

Consultar conexões sociais

Requisição completa (Bash):

curl --request GET \
  --url "$API_URL/api/EditorSocial/conexoes" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Accept: application/json"

Resposta ilustrativa — HTTP 200:

{
  "Version": "1.0.0.0",
  "StatusCode": 200,
  "Message": "Requisição efetuada com suceesso.",
  "Content": {
    "conexoes": []
  }
}

Solicitar publicação e interpretar erro de negócio

Requisição completa (Bash):

curl --request POST \
  --url "$API_URL/api/EditorSocial/publicar" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "ConexaoId": 123,
  "Rede": "instagram",
  "Imagens": [
    "https://example.com/imagem-exemplo.jpg"
  ],
  "Legenda": "Texto fictício para revisão.",
  "AgendarPara": null
}'

Resposta ilustrativa — HTTP 200:

{
  "Version": "1.0.0.0",
  "StatusCode": 200,
  "Message": "Requisição efetuada com suceesso.",
  "Content": {
    "status": "erro",
    "postId": null,
    "mensagem": "Publicação em configuração (aguardando aprovação da Meta). A captação de leads já está ativa."
  }
}

A resposta acima representa a condição publicação desabilitada prevista no service. HTTP 200 não significa post publicado: confira status. A URL é fictícia e deve ser substituída por arquivo válido. Editor de modelos usa ModeloPreProposta e ModeloDocumento; Estúdio de peças e campanhas usa Editor*, LandingPage e CampanhaEmail.

Referência dos endpoints

Landing pages — LandingPage

GET /api/LandingPage

query filtro: QueryFiltroInputDTO — QueryFiltroInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/LandingPage/{id}

path id: long.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

POST /api/LandingPage

body model: CriarLandingPageInputDTO — CriarLandingPageInputDTO.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/LandingPage/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/LandingPage/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/LandingPage/{id}/Conteudo

path id: long; body model: SalvarConteudoLandingPageInputDTO — SalvarConteudoLandingPageInputDTO.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/LandingPage/{id}/Publicar

path id: long; body model: PublicarLandingPageInputDTO — PublicarLandingPageInputDTO.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/LandingPage/{id}/Despublicar

path id: long.

Retorno declarado: Task<ActionResult<LandingPage>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/LandingPage/Publica/{slug}

path slug: string.

Retorno declarado: Task<ActionResult<LandingPagePublicaOutputDTO>>. Acesso: Pública; não exige JWT nesta action.

Voltar ao índice

GET /api/LandingPage/PublicaPorDominio

query dominio: string.

Retorno declarado: Task<ActionResult<LandingPagePublicaOutputDTO>>. Acesso: Pública; não exige JWT nesta action.

Voltar ao índice

POST /api/LandingPage/Publica/{slug}/Conversao

path slug: string.

Retorno declarado: Task<IActionResult>. Acesso: Pública; não exige JWT nesta action.

Voltar ao índice

Campanhas de e-mail — CampanhaEmail

GET /api/CampanhaEmail

query filtro: QueryFiltroInputDTO — QueryFiltroInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/CampanhaEmail/{id}

path id: long.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

POST /api/CampanhaEmail

body model: CriarCampanhaEmailInputDTO — CriarCampanhaEmailInputDTO.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/CampanhaEmail/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/CampanhaEmail/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/CampanhaEmail/{id}/Segmentacao

path id: long; body model: AtualizarSegmentacaoInputDTO — AtualizarSegmentacaoInputDTO.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/CampanhaEmail/{id}/MontarDestinatarios

path id: long.

Retorno declarado: Task<ActionResult<int>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/CampanhaEmail/{id}/Agendar

path id: long; body model: AgendarCampanhaEmailInputDTO — AgendarCampanhaEmailInputDTO.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/CampanhaEmail/{id}/Disparar

path id: long.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/CampanhaEmail/{id}/Cancelar

path id: long.

Retorno declarado: Task<ActionResult<CampanhaEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/CampanhaEmail/{id}/Destinatarios

path id: long; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<CampanhaEmailDestinatario>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/CampanhaEmail/{id}/Relatorio

path id: long.

Retorno declarado: Task<ActionResult<RelatorioCampanhaEmailOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

Conexão Meta, captação e publicação social — EditorSocial

GET /api/EditorSocial/conexoes

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/autorizar

query rede: string.

Retorno declarado: IActionResult. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

POST /api/EditorSocial/callback

body body: CallbackSocialInputDTO — CallbackSocialInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

DELETE /api/EditorSocial/conexoes/{id}

path id: long.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/origens

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

PUT /api/EditorSocial/conexoes/{id}/origem

path id: long; body body: DefinirOrigemInputDTO — DefinirOrigemInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

POST /api/EditorSocial/publicar

body body: PublicarSocialInputDTO — PublicarSocialInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/conexoes/{id}/formularios

path id: long.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

PUT /api/EditorSocial/conexoes/{id}/formularios/{formId}/mapeamento

path id: long; path formId: string; body body: SalvarMapeamentoInputDTO — SalvarMapeamentoInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/tipos-negocio

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/campos-groner

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: IActionResult. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorSocial/leads/logs

query pagina: int (padrão 1); query tamanho: int (padrão 20); query busca: string (padrão null).

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

POST /api/EditorSocial/leads/{leadgenId}/reprocessar

path leadgenId: string.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

POST /api/EditorSocial/conexoes/{id}/formularios/{formId}/testar

path id: long; path formId: string.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

Edição de documentos Office — EditorOnlyOffice

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/EditorOnlyOffice/config

query fileUrl: string; query title: string.

Retorno declarado: Task<ActionResult<EditorOnlyOfficeConfigResponseDTO>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

GET /api/EditorOnlyOffice/document

query fileUrl: string.

Retorno declarado: Task<IActionResult>. Acesso: Pública; não exige JWT nesta action.

Voltar ao índice

POST /api/EditorOnlyOffice/callback

query fileUrl: string.

Retorno declarado: Task<IActionResult>. Acesso: Pública; não exige JWT nesta action.

Voltar ao índice

Planejamento do Estúdio — EditorEstudioBriefing

POST /api/EditorEstudioBriefing/chat

body body: EditorBriefingChatInputDTO — EditorBriefingChatInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

Assistente do Editor — EditorBedrockAgent

GET /api/EditorBedrockAgent/creditos

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

POST /api/EditorBedrockAgent/invoke

body body: EditorBedrockInvokeInputDTO — EditorBedrockInvokeInputDTO; query buffered: bool (padrão false).

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

Geração de imagens — EditorBedrockImage

POST /api/EditorBedrockImage/generate

body body: EditorImagemInputDTO — EditorImagemInputDTO.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor,Tecnico.

Voltar ao índice

Modelos de proposta — ModeloPreProposta

Uso encontrado nos clients: Groner editor, Groner light. Compartilhamento não amplia permissões.

GET /api/ModeloPreProposta

query filtro: FiltroModeloDocumentoInputDTO — FiltroModeloDocumentoInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<ModeloPreProposta>>. Acesso: Bearer; perfis declarados: Administrador,Gerente, Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

GET /api/ModeloPreProposta/Ativas

query filtro: FiltroModeloPropostaAtivasInputDTO — FiltroModeloPropostaAtivasInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

GET /api/ModeloPreProposta/{id}

path id: long.

Retorno declarado: ActionResult<ModeloPreProposta>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/ModeloPreProposta

body model: AddModeloPrePropostaInputDTO — AddModeloPrePropostaInputDTO.

Retorno declarado: Task<ActionResult<ModeloPreProposta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/ModeloPreProposta/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<ModeloPreProposta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/ModeloPreProposta/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/ModeloPreProposta/Alteracoes/{id}

path id: long; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<HistoricoAlteracaoPreProposta>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

GET /api/ModeloPreProposta/AlteracaoById/{alteracaoId}

path alteracaoId: long.

Retorno declarado: Task<dynamic>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

Modelos de documento — ModeloDocumento

Uso encontrado nos clients: Groner editor, Groner light, Groner os. Compartilhamento não amplia permissões.

GET /api/ModeloDocumento

query filtro: FiltroModeloDocumentoInputDTO — FiltroModeloDocumentoInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<ModeloDocumento>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,PreVendedor, Tecnico.

Voltar ao índice

GET /api/ModeloDocumento/{id}

path id: long.

Retorno declarado: ActionResult<ModeloDocumento>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/ModeloDocumento

body model: ModeloDocumentoInputDTO — ModeloDocumentoInputDTO.

Retorno declarado: Task<ActionResult<ModeloDocumento>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/ModeloDocumento/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<ModeloDocumento>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/ModeloDocumento/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/ModeloDocumento/Alteracoes/{id}

path id: long; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<HistoricoAlteracaoDocumento>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

GET /api/ModeloDocumento/AlteracaoById/{alteracaoId}

path alteracaoId: long.

Retorno declarado: Task<dynamic>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,PreVendedor,Vendedor, Tecnico.

Voltar ao índice

GET /api/ModeloDocumento/PropriedadesProjetoEngenharia

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: ActionResult<IEnumerable<object>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

Modelos de e-mail — ModeloEmail

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/ModeloEmail

query filtro: QueryFiltroInputDTO — QueryFiltroInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<ModeloEmail>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

POST /api/ModeloEmail/Copiar/{id}

path id: long.

Retorno declarado: Task<ActionResult<ModeloEmail>>. Acesso: Acesso sujeito às regras do ambiente; use a credencial da integração e confirme a permissão desta operação.

Voltar ao índice

GET /api/ModeloEmail/{id}

path id: long.

Retorno declarado: Task<ActionResult<ModeloEmail>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

POST /api/ModeloEmail

body model: NomeInputDto — NomeInputDto.

Retorno declarado: Task<ActionResult<ModeloEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/ModeloEmail/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<ModeloEmail>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/ModeloEmail/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

Identidades de remetente — IdentidadeRemetente

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/IdentidadeRemetente

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<ActionResult<List<IdentidadeRemetenteOutputDTO>>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/IdentidadeRemetente/summary

Lista todas as identidades cadastradas (não excluídas).

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<ActionResult<IdentidadeRemetenteSummaryDTO>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/IdentidadeRemetente/{id}

Contagem de identidades agrupadas por status (Pendente, Verificado, Falhou, FalhaTemporaria).

path id: long.

Retorno declarado: Task<ActionResult<IdentidadeRemetenteOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/IdentidadeRemetente

body input: CriarIdentidadeRemetenteInputDTO — CriarIdentidadeRemetenteInputDTO.

Retorno declarado: Task<ActionResult<IdentidadeRemetenteOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/IdentidadeRemetente/{id}/verificar

Cria uma nova identidade no SES. Para Tipo=Dominio, a resposta traz os CNAMEs que precisam ser adicionados ao DNS. Para Tipo=Email, o SES envia link de verificação automaticamente para o endereço.

path id: long.

Retorno declarado: Task<ActionResult<IdentidadeRemetenteOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/IdentidadeRemetente/sincronizar-pendentes

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

Retorno declarado: Task<ActionResult<int>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/IdentidadeRemetente/{id}/reenviar

Sincroniza com SES o status de TODAS as identidades pendentes ou em falha temporária. Pode ser disparado por job em background. Retorna a quantidade processada.

path id: long.

Retorno declarado: Task<ActionResult<IdentidadeRemetenteOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/IdentidadeRemetente/{id}

path id: long.

Retorno declarado: Task<IActionResult>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

E-mails enviados — EmailEnviado

GET /api/EmailEnviado

query filtro: FiltroEmailEnviadoInputDTO — FiltroEmailEnviadoInputDTO; query paging: PagingParams.

Retorno declarado: Task<ActionResult<PagedList<EmailEnviadoListaOutputDTO>>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/EmailEnviado/{id}

path id: long.

Retorno declarado: Task<ActionResult<EmailEnviadoDetalheOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/EmailEnviado/relatorio

query filtro: FiltroEmailEnviadoInputDTO — FiltroEmailEnviadoInputDTO.

Retorno declarado: Task<ActionResult<RelatorioEmailOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

Eventos de entrega de e-mail — EmailEvento

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/EmailEvento

query filtro: FiltroEmailEventoInputDTO — FiltroEmailEventoInputDTO; query paging: PagingParams.

Retorno declarado: Task<ActionResult<PagedList<EmailEventoListaOutputDTO>>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/EmailEvento/{id}

path id: long.

Retorno declarado: Task<ActionResult<EmailEventoListaOutputDTO>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

GET /api/EmailEvento/summary

query filtro: FiltroEmailEventoInputDTO — FiltroEmailEventoInputDTO.

Retorno declarado: Task<ActionResult<EmailEventoSummaryDTO>>. Acesso: Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

Voltar ao índice

Integração Meta — Meta

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/Meta/MetasGeral

query model: ObterMetaInputDTO — ObterMetaInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

GET /api/Meta/MetasLoja

query model: ObterMetaInputDTO — ObterMetaInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

GET /api/Meta/MetasUsuario

query model: ObterMetaInputDTO — ObterMetaInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

GET /api/Meta/MetasUsuarioPorMes

query model: FiltroMetasPorMesInputDTO — FiltroMetasPorMesInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

GET /api/Meta/MetasLojaPorMes

query model: FiltroMetasPorMesInputDTO — FiltroMetasPorMesInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

GET /api/Meta/MetasGeralPorMes

query model: FiltroMetasPorMesInputDTO — FiltroMetasPorMesInputDTO.

Retorno declarado: Task<ActionResult<dynamic>>. Acesso: Bearer; perfis declarados: Administrador,Gerente,Supervisor,Vendedor,Tecnico.

Voltar ao índice

Configuração Meta — ConfiguracaoMeta

Uso encontrado nos clients: Groner light. Compartilhamento não amplia permissões.

GET /api/ConfiguracaoMeta

query filtro: ConfiguracaoMetaFiltroInputDTO — ConfiguracaoMetaFiltroInputDTO; query pagingParams: PagingParams.

Retorno declarado: ActionResult<PagedList<ConfiguracaoMeta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

GET /api/ConfiguracaoMeta/{id}

path id: long.

Retorno declarado: Task<ActionResult<ConfiguracaoMeta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

POST /api/ConfiguracaoMeta

body model: ConfigMetaInputDTO — ConfigMetaInputDTO.

Retorno declarado: Task<ActionResult<ConfiguracaoMeta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

PUT /api/ConfiguracaoMeta/{id}

path id: long; body model: EditarPropriedadeInputDTO — EditarPropriedadeInputDTO.

Retorno declarado: Task<ActionResult<ConfiguracaoMeta>>. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

DELETE /api/ConfiguracaoMeta/{id}

path id: long.

Retorno declarado: Task. Acesso: Bearer; perfis declarados: Administrador.

Voltar ao índice

Veja também

• Guia principal, autenticação e coleção Postman
• Como gerar token de API
• Limites de requisições

Atualizado em: 14/10/2026