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

# Send a notification to end users

> Queues one message to many end users through the workspace's end-user Teams app, and returns at once with `state` `QUEUED`; read progress with `GET /public-api/end-user-notifications/{id}`. `end_company_ids` null sends to everyone the app reaches (as the reach with no companies). `recipients` is `"all"` or the `user_id`s from the reach with `include_people=true`; a picked person the app cannot reach is recorded `NOT_REACHABLE`, and a pick with more than 50 such people is refused with `400`. `message` is markdown, up to 4,000 characters. Each company gets at most 25 notices a minute, so a large send takes minutes. A reply from an end user is a normal chat turn and bills as one. `idempotency_key` (1 to 200 characters) is new for each notification: a request repeated with the same key returns the first notification and sends nothing again. `400` with what to change when the workspace has no active end-user Teams app, another notification is still sending, or the request is out of bounds. `429` after 20 new sends in an hour. Needs an admin or owner, or a member an admin gave the Send end-user notifications permission, else `403 insufficient_scope`. A triggered or scheduled agent run, with no person behind it, gets `403` too.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json post /public-api/end-user-notifications
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: >-
      Every tool call the tenant's agents made in the last 30 days, within the
      caller's workflow access.
    name: Audit Log
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/end-user-notifications:
    post:
      tags:
        - End-user notifications
      summary: Send a notification to end users
      description: >-
        Queues one message to many end users through the workspace's end-user
        Teams app, and returns at once with `state` `QUEUED`; read progress with
        `GET /public-api/end-user-notifications/{id}`. `end_company_ids` null
        sends to everyone the app reaches (as the reach with no companies).
        `recipients` is `"all"` or the `user_id`s from the reach with
        `include_people=true`; a picked person the app cannot reach is recorded
        `NOT_REACHABLE`, and a pick with more than 50 such people is refused
        with `400`. `message` is markdown, up to 4,000 characters. Each company
        gets at most 25 notices a minute, so a large send takes minutes. A reply
        from an end user is a normal chat turn and bills as one.
        `idempotency_key` (1 to 200 characters) is new for each notification: a
        request repeated with the same key returns the first notification and
        sends nothing again. `400` with what to change when the workspace has no
        active end-user Teams app, another notification is still sending, or the
        request is out of bounds. `429` after 20 new sends in an hour. Needs an
        admin or owner, or a member an admin gave the Send end-user
        notifications permission, else `403 insufficient_scope`. A triggered or
        scheduled agent run, with no person behind it, gets `403` too.
      operationId: public_api.end_user_notifications_create_post
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEndUserNotificationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PublicEndUserNotification'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    CreateEndUserNotificationRequest:
      additionalProperties: false
      description: A message to send to end users through the end-user Teams app.
      properties:
        end_company_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: End Company Ids
        idempotency_key:
          title: Idempotency Key
          type: string
        message:
          title: Message
          type: string
        only_recent_chatters:
          default: false
          title: Only Recent Chatters
          type: boolean
        recipients:
          anyOf:
            - const: all
              type: string
            - items:
                type: string
              type: array
          title: Recipients
      required:
        - message
        - end_company_ids
        - recipients
        - idempotency_key
      title: CreateEndUserNotificationRequest
      type: object
    PublicEndUserNotification:
      description: One message sent to many end users, with how many received it.
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        end_company_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: End Company Ids
        failed_count:
          title: Failed Count
          type: integer
        finished_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Finished At
        id:
          title: Id
          type: string
        message:
          title: Message
          type: string
        not_reachable_count:
          title: Not Reachable Count
          type: integer
        only_recent_chatters:
          title: Only Recent Chatters
          type: boolean
        picked_people_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Picked People Count
        recipients_total:
          title: Recipients Total
          type: integer
        sent_by:
          title: Sent By
          type: string
        sent_count:
          title: Sent Count
          type: integer
        started_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Started At
        state:
          $ref: '#/components/schemas/EndUserNotificationState'
      required:
        - id
        - state
        - message
        - sent_by
        - end_company_ids
        - picked_people_count
        - only_recent_chatters
        - recipients_total
        - sent_count
        - not_reachable_count
        - failed_count
        - created_at
        - started_at
        - finished_at
      title: PublicEndUserNotification
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    EndUserNotificationState:
      enum:
        - QUEUED
        - SENDING
        - DONE
        - FAILED
      title: EndUserNotificationState
      type: string
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````

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