> ## Documentation Index
> Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Dicionário: Comunicados v2

> Os valores do módulo de Comunicados na API v2: perfis de visibilidade e os campos booleanos de leitura, aceite e envio por e-mail

<span className="badge-v2">API v2</span>

O módulo de Comunicados não usa códigos numéricos: o estado vem em campos booleanos e o público em códigos de texto. Use Ctrl+F para achar qualquer valor.

## Perfis de visibilidade (`visibilityRoleType`)

O campo é uma lista, então um comunicado pode ser visível para os dois perfis ao mesmo tempo.

| Valor | Significado |
| - | - |
| `ADMIN` | Usuários da administradora da rede |
| `COMPANY` | Usuários das unidades |

## Campos de estado do comunicado

| Campo | Significado |
| - | - |
| `active` | Comunicado ativo. Na listagem, `active=true` é o padrão do filtro |
| `required` | A leitura exige aceite do destinatário |
| `sendEmail` | O comunicado também é enviado por e-mail |
| `emailWithContent` | O e-mail leva o conteúdo completo, não apenas o aviso |

## Campos de leitura por pessoa

Retornados em `announcement/user/list`, um registro por pessoa do comunicado.

| Campo | Significado |
| - | - |
| `viewed` | A pessoa visualizou o comunicado |
| `viewedAt` | Data da visualização, em UTC ISO 8601. Nulo quando ainda não houve visualização |
| `accepted` | A pessoa registrou o aceite. Relevante quando o comunicado tem `required` verdadeiro |

## Datas de publicação

`publishStartDate` e `publishEndDate` usam o formato `yyyy-MM-dd`, sem hora, diferente de `createdAt` e `viewedAt`, que são UTC ISO 8601. Um `publishEndDate` nulo significa que o comunicado não tem prazo para sair do ar.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Referência de Comunicados" icon="megaphone" href="/v2/api-reference/comunicados/listar-comunicados">
    Os três endpoints do módulo, com parâmetros e playground.
  </Card>

  <Card title="Convenções da v2" icon="book" href="/v2/convencoes">
    Paginação, datas e limites que valem para toda a v2.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.