> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.groner.app/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# 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](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/) · [Exemplos](#2-exemplos-de-requisicao-e-resposta) · [Endpoints](#2-referencia-dos-endpoints)

|| Revisão: **14/10/2026**. Classificação conferida nos clients dos produtos e nas rotas registradas do servidor. Respostas abaixo são exemplos completos do contrato escolhido com dados fictícios, não capturas de produção.

## Índice clicável

[Landing pages — LandingPage](#3-landing-pages-landingpage) · [Campanhas de e-mail — CampanhaEmail](#3-campanhas-de-e-mail-campanhaemail) · [Conexão Meta, captação e publicação social — EditorSocial](#3-conexao-meta-captacao-e-publicacao-social-editorsocial) · [Edição de documentos Office — EditorOnlyOffice](#3-edicao-de-documentos-office-editoronlyoffice) · [Planejamento do Estúdio — EditorEstudioBriefing](#3-planejamento-do-estudio-editorestudiobriefing) · [Assistente do Editor — EditorBedrockAgent](#3-assistente-do-editor-editorbedrockagent) · [Geração de imagens — EditorBedrockImage](#3-geracao-de-imagens-editorbedrockimage) · [Modelos de proposta — ModeloPreProposta](#3-modelos-de-proposta-modelopreproposta) · [Modelos de documento — ModeloDocumento](#3-modelos-de-documento-modelodocumento) · [Modelos de e-mail — ModeloEmail](#3-modelos-de-e-mail-modeloemail) · [Identidades de remetente — IdentidadeRemetente](#3-identidades-de-remetente-identidaderemetente) · [E-mails enviados — EmailEnviado](#3-e-mails-enviados-emailenviado) · [Eventos de entrega de e-mail — EmailEvento](#3-eventos-de-entrega-de-e-mail-emailevento) · [Integração Meta — Meta](#3-integracao-meta-meta) · [Configuração Meta — ConfiguracaoMeta](#3-configuracao-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):**

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

**Resposta ilustrativa — HTTP 200:**

```json
{
  "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):**

```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:**

```json
{
  "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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-queryfiltroinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `POST /api/LandingPage`

**body** `model`: `CriarLandingPageInputDTO` — [CriarLandingPageInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criarlandingpageinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/LandingPage/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/LandingPage/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/LandingPage/{id}/Conteudo`

**path** `id`: `long`; **body** `model`: `SalvarConteudoLandingPageInputDTO` — [SalvarConteudoLandingPageInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-salvarconteudolandingpageinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/LandingPage/{id}/Publicar`

**path** `id`: `long`; **body** `model`: `PublicarLandingPageInputDTO` — [PublicarLandingPageInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-publicarlandingpageinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/LandingPage/{id}/Despublicar`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `GET /api/LandingPage/PublicaPorDominio`

**query** `dominio`: `string`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

### Campanhas de e-mail — CampanhaEmail

#### `GET /api/CampanhaEmail`

**query** `filtro`: `QueryFiltroInputDTO` — [QueryFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-queryfiltroinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `POST /api/CampanhaEmail`

**body** `model`: `CriarCampanhaEmailInputDTO` — [CriarCampanhaEmailInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criarcampanhaemailinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/CampanhaEmail/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/CampanhaEmail/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/CampanhaEmail/{id}/Segmentacao`

**path** `id`: `long`; **body** `model`: `AtualizarSegmentacaoInputDTO` — [AtualizarSegmentacaoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-atualizarsegmentacaoinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/CampanhaEmail/{id}/MontarDestinatarios`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/CampanhaEmail/{id}/Agendar`

**path** `id`: `long`; **body** `model`: `AgendarCampanhaEmailInputDTO` — [AgendarCampanhaEmailInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-agendarcampanhaemailinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/CampanhaEmail/{id}/Disparar`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/CampanhaEmail/{id}/Cancelar`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

### 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](#2-indice-clicavel)

#### `GET /api/EditorSocial/autorizar`

**query** `rede`: `string`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/EditorSocial/callback`

**body** `body`: `CallbackSocialInputDTO` — [CallbackSocialInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-callbacksocialinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

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

**path** `id`: `long`; **body** `body`: `DefinirOrigemInputDTO` — [DefinirOrigemInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-definirorigeminputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/EditorSocial/publicar`

**body** `body`: `PublicarSocialInputDTO` — [PublicarSocialInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-publicarsocialinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

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

**path** `id`: `long`; **path** `formId`: `string`; **body** `body`: `SalvarMapeamentoInputDTO` — [SalvarMapeamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-salvarmapeamentoinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

### 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](#2-indice-clicavel)

#### `GET /api/EditorOnlyOffice/document`

**query** `fileUrl`: `string`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/EditorOnlyOffice/callback`

**query** `fileUrl`: `string`.

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

[Voltar ao índice](#2-indice-clicavel)

### Planejamento do Estúdio — EditorEstudioBriefing

#### `POST /api/EditorEstudioBriefing/chat`

**body** `body`: `EditorBriefingChatInputDTO` — [EditorBriefingChatInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editorbriefingchatinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

### 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](#2-indice-clicavel)

#### `POST /api/EditorBedrockAgent/invoke`

**body** `body`: `EditorBedrockInvokeInputDTO` — [EditorBedrockInvokeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editorbedrockinvokeinputdto); **query** `buffered`: `bool` (padrão `false`).

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

[Voltar ao índice](#2-indice-clicavel)

### Geração de imagens — EditorBedrockImage

#### `POST /api/EditorBedrockImage/generate`

**body** `body`: `EditorImagemInputDTO` — [EditorImagemInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editorimageminputdto).

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

[Voltar ao índice](#2-indice-clicavel)

### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtromodelodocumentoinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ModeloPreProposta/Ativas`

**query** `filtro`: `FiltroModeloPropostaAtivasInputDTO` — [FiltroModeloPropostaAtivasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtromodelopropostaativasinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ModeloPreProposta/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ModeloPreProposta`

**body** `model`: `AddModeloPrePropostaInputDTO` — [AddModeloPrePropostaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addmodeloprepropostainputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/ModeloPreProposta/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ModeloPreProposta/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtromodelodocumentoinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ModeloDocumento/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ModeloDocumento`

**body** `model`: `ModeloDocumentoInputDTO` — [ModeloDocumentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-modelodocumentoinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/ModeloDocumento/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ModeloDocumento/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

### Modelos de e-mail — ModeloEmail

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

#### `GET /api/ModeloEmail`

**query** `filtro`: `QueryFiltroInputDTO` — [QueryFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-queryfiltroinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `POST /api/ModeloEmail`

**body** `model`: `NomeInputDto` — [NomeInputDto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-nomeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/ModeloEmail/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ModeloEmail/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

### 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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `POST /api/IdentidadeRemetente`

**body** `input`: `CriarIdentidadeRemetenteInputDTO` — [CriarIdentidadeRemetenteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criaridentidaderemetenteinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `DELETE /api/IdentidadeRemetente/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

### E-mails enviados — EmailEnviado

#### `GET /api/EmailEnviado`

**query** `filtro`: `FiltroEmailEnviadoInputDTO` — [FiltroEmailEnviadoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-filtroemailenviadoinputdto); **query** `paging`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `GET /api/EmailEnviado/relatorio`

**query** `filtro`: `FiltroEmailEnviadoInputDTO` — [FiltroEmailEnviadoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-filtroemailenviadoinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

### 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](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-filtroemaileventoinputdto); **query** `paging`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `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](#2-indice-clicavel)

#### `GET /api/EmailEvento/summary`

**query** `filtro`: `FiltroEmailEventoInputDTO` — [FiltroEmailEventoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-filtroemaileventoinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

### Integração Meta — Meta

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

#### `GET /api/Meta/MetasGeral`

**query** `model`: `ObterMetaInputDTO` — [ObterMetaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-obtermetainputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Meta/MetasLoja`

**query** `model`: `ObterMetaInputDTO` — [ObterMetaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-obtermetainputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Meta/MetasUsuario`

**query** `model`: `ObterMetaInputDTO` — [ObterMetaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-obtermetainputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Meta/MetasUsuarioPorMes`

**query** `model`: `FiltroMetasPorMesInputDTO` — [FiltroMetasPorMesInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrometaspormesinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Meta/MetasLojaPorMes`

**query** `model`: `FiltroMetasPorMesInputDTO` — [FiltroMetasPorMesInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrometaspormesinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Meta/MetasGeralPorMes`

**query** `model`: `FiltroMetasPorMesInputDTO` — [FiltroMetasPorMesInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrometaspormesinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

### Configuração Meta — ConfiguracaoMeta

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

#### `GET /api/ConfiguracaoMeta`

**query** `filtro`: `ConfiguracaoMetaFiltroInputDTO` — [ConfiguracaoMetaFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-configuracaometafiltroinputdto); **query** `pagingParams`: `PagingParams`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ConfiguracaoMeta/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ConfiguracaoMeta`

**body** `model`: `ConfigMetaInputDTO` — [ConfigMetaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-configmetainputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/ConfiguracaoMeta/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

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

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ConfiguracaoMeta/{id}`

**path** `id`: `long`.

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

[Voltar ao índice](#2-indice-clicavel)


<!-- groner-suporte:veja-tambem:inicio -->
## Veja também

* [Guia principal, autenticação e coleção Postman](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/)
* [Como gerar token de API](https://ajuda.groner.app/pt-br/article/como-gerar-um-token-de-api-para-integrar-o-groner-com-outros-sistemas-2okhj6/)
* [Limites de requisições](https://ajuda.groner.app/pt-br/article/limites-de-requisicoes-da-api-da-groner-1cwtj65/)
<!-- groner-suporte:veja-tambem:fim -->