---
title: "Send a Message as an AI Agent Output"
method: POST
path: "/v2.0/endpoint/notify"
tags: ["Endpoints"]
---

# Send a Message as an AI Agent Output

`POST /v2.0/endpoint/notify`

Sends a message as an AI Agent Output. It bypasses the Flow's input processing and delivers a message to the user. For example, sending `Your order 12345 has shipped` as a status update.

## Request body

- object
  - `userId` string, email, required
  - `text` string, required
  - `data` object, required
  - `attachments` union[]
    - union
      - object
        - `name` string, required
        - `caption` string
        - `url` string, required
        - `type` 'file' | 'document', required
        - `mimeType` string
      - object
        - `name` string, required
        - `caption` string
        - `url` string, required
        - `type` 'image', required
        - `mimeType` string
      - object
        - `name` string, required
        - `caption` string
        - `url` string, required
        - `type` 'video', required
        - `mimeType` string
      - object
        - `name` string, required
        - `caption` string
        - `url` string, required
        - `type` 'audio', required
        - `mimeType` string
      - object
        - `name` string, required
        - `caption` string
        - `url` string, required
        - `type` 'sticker', required
        - `mimeType` string
      - object
        - `type` 'contact', required
        - `addresses` object[]
          - `city` string
          - `country` string
          - `countryCode` string
          - `state` string
          - `street` string
          - `type` 'HOME' | 'WORK'
          - `zip` string
          - `postOfficeBox` string
          - `extendedAddress` string
          - `latitude` number
          - `longitude` number
        - `birthday` string
        - `emails` object[]
          - `email` string
          - `type` 'HOME' | 'WORK'
        - `urls` object[]
          - `url` string
          - `type` 'HOME' | 'WORK'
        - `photos` string[]
        - `gender` string
        - `languages` string[]
        - `timeZone` string
        - `notes` string[]
      - object
        - `type` 'location', required
        - `latitude` number, required
        - `longitude` number, required
        - `name` string
        - `title` string
        - `address` string
  - `URLToken` string, required
  - `sessionId` string

## Response `200`

Returns success message.

## Other responses

- `400` — Bad request - invalid or missing required arguments.
- `401` — The request has not been applied because it lacks valid authentication credentials for the target resource.
- `402` — Upgrade your Plan to increase your Quota.
- `403` — The server understood the request but refuses to authorize it.
- `404` — Endpoint not found.
- `405` — The method received in the request-line is known by the origin server but not supported by the target resource.
- `409` — The request conflicts with current state of the server.
- `413` — The request entity is larger than limits defined by server.
- `500` — Internal server error.
- `501` — The server does not support the functionality required to fulfill the request.
- `502` — The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
- `503` — The server is not ready to handle the request.
- `504` — The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.

---

[API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/revisions/85b2872bdfb7/schema)