> ## Documentation Index > Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt > Use this file to discover all available pages before exploring further. # Criar regra de destinatário > Criar regra de destinatário. Exige a ação IAM **`notifications:Publish`**. Veja [permissões de Email](/pt/email/permissions) for the full list, what each one covers, and an example policy. ## OpenAPI ````yaml /pt/api-reference/specs/email.yaml post /v1/identities/{identity_id}/recipient-rules openapi: 3.0.3 info: title: API Basaltic Email version: 1.0.0 description: > API regional para enviar e receber emails, gerenciar identidades e registros DNS, templates, conjuntos de configurações, pools de IPs, regras de destinatário, conteúdo e anexos. As identidades devem ser verificadas em cada região. Crie uma identidade, publique seus dns_records e solicite a verificação. Apenas identidades verificadas podem enviar ou ativar o recebimento. Referências aceitam UUID, nome exclusivo na conta ou CRN do tipo esperado. Nomes são imutáveis. Referências malformadas ou de tipo/região incorretos retornam 400; inexistentes ou de outra conta retornam 404. Caminhos de recursos usam UUIDs. Filtros são exatos, limitados à conta e aplicados antes da paginação; referências inexistentes ou de outro escopo retornam resultados vazios. O conteúdo enviado e recebido expira após 30 dias. Os objetos dos anexos seguem o ciclo de vida do bucket independentemente. Use Telemetry para métricas agregadas e os endpoints de diagnóstico para eventos e registros DMARC. contact: name: Basaltic Support email: ping@basaltic.sh license: name: Proprietary url: https://basaltic.sh/terms servers: - url: https://email.{region}.basaltic.sh description: Endpoint de API regional variables: region: default: sa-saopaulo-1 description: Código de região security: - BearerAuth: [] tags: - name: Email description: Envio de emails para clientes (regional). paths: /v1/identities/{identity_id}/recipient-rules: post: tags: - Email summary: Criar regra de destinatário description: Criar regra de destinatário. operationId: createRecipientRule parameters: - name: identity_id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRecipientRuleRequest' responses: '201': description: Sucesso content: application/json: schema: $ref: '#/components/schemas/RecipientRuleResponse' '400': description: Solicitação inválida. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Autenticação necessária. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Permissão negada. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Recurso não encontrado. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Estado conflitante. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Cota ou limite de taxa excedido. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Erro interno. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Dependência indisponível. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: CreateRecipientRuleRequest: type: object required: - match_type - topic properties: match_type: type: string enum: - exact - prefix - all description: >- Parte local exata, prefixo ou todos os endereços desta identidade. Correspondências exatas têm prioridade, depois o prefixo mais longo e por último todos os endereços. local_part: type: string maxLength: 64 description: Obrigatório para exact e prefix; vazio ou omitido para all. topic: type: string description: >- Nome, UUID ou CRN do tópico Notifications. Exige notifications:Publish no tópico da mesma conta. enabled: type: boolean default: true RecipientRuleResponse: type: object required: - rule properties: rule: $ref: '#/components/schemas/RecipientRule' Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string description: Código de erro identificando o tipo de erro example: INVALID_INPUT message: type: string description: Mensagem de erro legível pelo ser humano example: Invalid request parameters params: type: object additionalProperties: true description: >- Valores não sensíveis opcionais para interpolação de erros localizados, codificados por código de erro. Nunca presente para erros de servidor. example: instances: 2 pools: 0 request_id: type: string format: uuid description: Solicitar ID para depuração example: 550e8400-e29b-41d4-a716-446655440000 RecipientRule: type: object required: - id - crn - local_part - match_type - topic - enabled properties: id: type: string format: uuid crn: type: string local_part: type: string topic: allOf: - $ref: '#/components/schemas/ResourceRef' example: id: 3c90c3cc-0d44-4b50-8888-8dd25736052a crn: crn:notifications:sa-saopaulo-1:acme:topic/incoming-mail name: incoming-mail enabled: type: boolean match_type: type: string enum: - exact - prefix - all description: >- Parte local exata, prefixo ou todos os endereços desta identidade. Correspondências exatas têm prioridade, depois o prefixo mais longo e por último todos os endereços. ResourceRef: type: object required: - id - crn properties: id: type: string format: uuid example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1 crn: type: string example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1 name: type: string description: >- Rótulo no momento da resposta: o nome do recurso, quando houver, ou seu rótulo legível (número de fatura, nome de exibição da conta). Ausente quando o destino não existe mais. Não é uma chave de consulta. example: Brazil securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >+ Um token bearer OAuth 2.0, enviado como `Authorization: Bearer `. Esta é a forma recomendada de autenticação. Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você. ``` curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \ https://iam.basaltic.sh/v1/oauth/token ``` Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.