> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar push

> Envia push para um ou vários destinatários. Escreva o texto na hora ou use um template.



## OpenAPI

````yaml /push-api/api-reference/openapi-push.json post /v1/push/messages
openapi: 3.0.3
info:
  title: Notifique API Push
  description: >-
    Envie notificações push e gerencie apps e dispositivos. Autentique com
    `Authorization: Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfPushBearerAuth: []
  - ntfPushApiKeyHeader: []
tags:
  - name: Push Apps
    description: >-
      CRUD de aplicações de push (um app por produto; credenciais
      Web/Android/iOS por app)
  - name: Push Devices
    description: Registro e listagem de dispositivos/subscriptions
  - name: Push Messages
    description: Envio, consulta e cancelamento de notificações push
paths:
  /v1/push/messages:
    post:
      tags:
        - Push Messages
      summary: Enviar push
      description: >-
        Envia push para um ou vários destinatários. Escreva o texto na hora ou
        use um template.
      operationId: ntfPush_postV1PushMessages
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: Chave única para evitar envio duplicado.
          schema:
            type: string
        - name: x-idempotency-key
          in: header
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfPush_SendPushRequest'
            examples:
              push:
                summary: Push
                value:
                  to:
                    - clxxdevice1...
                  type: push
                  payload:
                    title: Olá!
                    body: Você tem uma nova mensagem.
                    url: https://seusite.com/notificacoes
                    icon: https://seusite.com/icon.png
                  options:
                    priority: high
                    webhook:
                      url: https://api.seudominio.com/hooks/push-events
                  metadata:
                    deeplink: order/99
              template:
                summary: Template do workspace
                value:
                  to:
                    - clxxdevice1...
                  type: template
                  payload:
                    templateId: tpl_abc123
                    variables:
                      name: Maria
      responses:
        '200':
          description: >-
            Resposta em cache (idempotency): mesma resposta do 202 da primeira
            chamada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_SendPushResponse'
        '202':
          description: Push aceito(s). Enfileirado(s) para envio imediato ou agendado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_SendPushResponse'
              example:
                success: true
                data:
                  status: QUEUED
                  count: 2
                  messageIds:
                    - clxxpush1...
                    - clxxpush2...
                  pushIds:
                    - clxxpush1...
                    - clxxpush2...
        '400':
          description: >-
            Validação: to vazio, title/body ausentes, device não encontrado,
            options.priority inválido, agendamento além do permitido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_ErrorResponse'
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_ErrorResponse'
        '402':
          description: >-
            Trial/plano expirado, créditos/saldo insuficientes ou limite de
            gasto da API Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_ErrorResponse'
        '403':
          description: >-
            Escopo push:send ausente ou créditos insuficientes
            (PLAN_LIMIT_CREDITS) ou agendamento não permitido
            (PLAN_LIMIT_SCHEDULING).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_ErrorResponse'
        '404':
          description: Um ou mais device IDs não encontrados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPush_ErrorResponse'
components:
  schemas:
    NtfPush_SendPushRequest:
      type: object
      required:
        - to
        - type
        - payload
      properties:
        to:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 100
          description: IDs de dispositivos push registrados (1–100 por chamada).
        type:
          type: string
          enum:
            - push
            - template
          description: >-
            Tipo: `push` (conteúdo em `payload`) ou `template` (template do
            workspace em `payload.templateId`).
        payload:
          type: object
          description: >-
            Conteúdo conforme `type`. **push:** pelo menos `title` ou `body`;
            opcionais `url`, `icon`, `image`, `data`. **template:** `templateId`
            (obrigatório) e `variables` opcionais.
        schedule:
          type: object
          properties:
            sendAt:
              type: string
              format: date-time
        options:
          type: object
          properties:
            priority:
              type: string
              enum:
                - high
                - normal
                - low
              default: normal
              description: >-
                `high` = fila Redis prioritária de push e fila prioritária de
                webhooks.
            webhook:
              type: object
              description: 'Webhook só para este envio: eventos `push.*` deste lote.'
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                secret:
                  type: string
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Metadados em `PushLog.metadata` (string→string).
    NtfPush_SendPushResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          required:
            - status
            - count
            - messageIds
          properties:
            status:
              type: string
              enum:
                - QUEUED
                - SCHEDULED
            count:
              type: integer
            messageIds:
              type: array
              items:
                type: string
              description: IDs canônicos das notificações criadas.
            pushIds:
              type: array
              items:
                type: string
              description: Alias de compatibilidade para messageIds. Mesmo valor.
            scheduledAt:
              type: string
              format: date-time
    NtfPush_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: object
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfPushBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfPushApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-key: sk_live_xxxxx'

````