> ## 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.

# Send Instagram message

> Send a direct message to one or more recipients on Instagram. Write the text directly or use a template.



## OpenAPI

````yaml /en/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/messages
openapi: 3.0.3
info:
  title: Notifique API — Instagram
  version: 1.0.0
  description: >-
    Send Instagram DMs and manage connections. Authenticate with `Authorization:
    Bearer sk_live_...` or `x-api-key`.
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfIgBearerAuth: []
  - ntfIgApiKeyHeader: []
tags:
  - name: 'Instagram: instances'
    description: Criar, listar, desconectar e remover conexões Instagram.
  - name: 'Instagram: messages'
    description: Enviar, listar, editar, cancelar, apagar e inbound.
  - name: 'Instagram: comments'
    description: Listr, responder e moderar comentários.
  - name: 'Instagram: media'
    description: Recent account posts and media (automation triggers).
paths:
  /v1/instagram/messages:
    post:
      tags:
        - 'Instagram: mensagens'
      summary: Send Instagram message
      description: >-
        Send a direct message to one or more recipients on Instagram. Write the
        text directly or use a template.
      operationId: ntfIg_sendMessage
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
          description: Evita duplicar envio em retry.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfIg_SendMessageBody'
            examples:
              text:
                summary: Text
                value:
                  to:
                    - username_ou_igsid
                  type: text
                  payload:
                    message: Olá!
                  from: inst_abc
              image:
                summary: Image
                value:
                  to:
                    - username_ou_igsid
                  type: image
                  payload:
                    mediaUrl: https://example.com/image.jpg
                    caption: Legenda opcional
                    mimetype: image/jpeg
                    fileName: photo.jpg
                  from: inst_abc
              video:
                summary: Video
                value:
                  to:
                    - username_ou_igsid
                  type: video
                  payload:
                    mediaUrl: https://example.com/video.mp4
                    caption: Legenda opcional
                    mimetype: video/mp4
                    fileName: clip.mp4
                  from: inst_abc
              audio:
                summary: Audio
                value:
                  to:
                    - username_ou_igsid
                  type: audio
                  payload:
                    mediaUrl: https://example.com/audio.mp3
                    mimetype: audio/mpeg
                    fileName: audio.mp3
                  from: inst_abc
              document:
                summary: Document
                value:
                  to:
                    - username_ou_igsid
                  type: document
                  payload:
                    mediaUrl: https://example.com/file.pdf
                    fileName: file.pdf
                    mimetype: application/pdf
                  from: inst_abc
              template:
                summary: Template do workspace
                value:
                  to:
                    - username_ou_igsid
                  type: template
                  payload:
                    templateId: tpl_abc123
                    variables:
                      name: Maria
                  from: inst_abc
              scheduled:
                summary: Agendado
                value:
                  to:
                    - username_ou_igsid
                  type: text
                  payload:
                    message: Lembrete amanhã às 10h
                  schedule:
                    sendAt: '2026-12-31T14:00:00.000Z'
                  from: inst_abc
      responses:
        '202':
          description: Enfileirada ou agendada.
          content:
            application/json:
              example:
                success: true
                data:
                  messageIds:
                    - msg_abc
                  status: QUEUED
                  count: 1
              schema:
                $ref: '#/components/schemas/ntfIg_SendMessageResponse'
        '400':
          description: Validação do body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              example:
                success: false
                error: Bad Request
                message: Validation failed
                details:
                  - path: payload.message
                    message: Required
        '402':
          description: Créditos insuficientes ou plano bloqueado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              example:
                success: false
                error: Payment Required
                code: INSUFFICIENT_CREDITS
                message: Insufficient credits
        '403':
          description: Sem escopo ou instance não permitida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '409':
          description: >-
            Sessão Instagram perdida (`INSTAGRAM_SESSION_LOST`) ou conta
            divergente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              example:
                success: false
                error: Conflict
                code: INSTAGRAM_SESSION_LOST
                message: Instagram session lost. Reconnect the instance.
        '429':
          description: >-
            Backlog do workspace (`WORKSPACE_BACKLOG_LIMIT`,
            `WORKSPACE_BACKLOG_SOFT_LIMIT`), warm-up
            (`INSTAGRAM_WARMUP_DAILY_LIMIT`) ou limite diário do Sandbox.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              examples:
                warmup:
                  summary: Warm-up
                  value:
                    success: false
                    error: Too Many Requests
                    code: INSTAGRAM_WARMUP_DAILY_LIMIT
                    message: 'Warm-up daily limit is 15 DMs. Sent today: 15.'
                    data:
                      active: true
                      dailyLimit: 15
                      sentToday: 15
                      daysRemaining: 4
                queue:
                  summary: Fila
                  value:
                    success: false
                    error: Too Many Requests
                    message: Workspace backlog limit
                    code: WORKSPACE_BACKLOG_LIMIT
        '503':
          description: Falha ao enfileirar (`SERVICE_UNAVAILABLE`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfIg_ErrorResponse'
              example:
                success: false
                error: Service Unavailable
                code: SERVICE_UNAVAILABLE
                message: Failed to enqueue Instagram message
components:
  schemas:
    NtfIg_SendMessageBody:
      type: object
      required:
        - from
        - to
        - type
        - payload
      properties:
        to:
          type: array
          minItems: 1
          maxItems: 500
          items:
            type: string
          example:
            - usuario_alvo
          description: Username (com ou sem @) ou ID numérico (IGSID). Até 500 por chamada.
        type:
          type: string
          enum:
            - text
            - image
            - video
            - audio
            - document
            - template
        payload:
          type: object
          description: >-
            text: `message`. Mídia: `mediaUrl`, `mimetype`, `fileName` e
            `caption` opcional. template: `templateId` e `variables`.
          additionalProperties: true
          properties:
            message:
              type: string
              example: Olá!
            mediaUrl:
              type: string
              example: https://example.com/image.jpg
            caption:
              type: string
              example: Legenda opcional
            mimetype:
              type: string
              example: image/jpeg
            fileName:
              type: string
              example: photo.jpg
            templateId:
              type: string
              example: tpl_abc123
            variables:
              type: object
              additionalProperties: true
              example:
                name: Maria
              properties:
                name:
                  type: string
                  example: Maria
        priority:
          type: string
          enum:
            - high
            - normal
            - low
        maxRetries:
          type: integer
          minimum: 0
          maximum: 5
        metadata:
          type: object
          additionalProperties: true
        schedule:
          type: object
          properties:
            sendAt:
              type: string
              format: date-time
              description: Agendamento canônico (ISO 8601).
        from:
          type: string
          description: 'Instância Instagram: id ou nome.'
      example:
        to:
          - usuario_alvo
        type: text
        payload: {}
        priority: high
        maxRetries: 1
        metadata: {}
        schedule:
          sendAt: '2025-02-10T14:00:00.000Z'
        from: inst_abc
    ntfIg_SendMessageResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            messageIds:
              type: array
              items:
                type: string
              example:
                - msg_abc
            status:
              type: string
              example: QUEUED
            count:
              type: integer
              example: 1
      example:
        success: true
        data:
          messageIds:
            - msg_abc
          status: QUEUED
          count: 1
    NtfIg_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
        code:
          type: string
        details:
          type: object
          additionalProperties: true
        data:
          type: object
          additionalProperties: true
          properties:
            id:
              type: string
              example: inst_abc
            status:
              type: string
              example: PENDING
            active:
              type: boolean
              example: true
            dailyLimit:
              type: integer
              example: 15
            sentToday:
              type: integer
              example: 15
            daysRemaining:
              type: integer
              example: 4
        retryAfterSec:
          type: integer
          description: >-
            Segundos até poder tentar de novo (presente em 429 de cooldown/abuse
            pause).
      example:
        success: false
        error: string
        message: string
        code: string
        details: {}
        data: {}
        retryAfterSec: 1
  securitySchemes:
    ntfIgBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_...'
    ntfIgApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````