POST /requests/{requestId}/messages

Create a new message for a request.

Messages are displayed in the Messages tab of the request detail page, alongside email and SMS logs.

Path parameters

  • requestId string Required

    The ID of the request

application/json

Body Required

  • title string Required

    The title/subject of the message

  • text string | null

    The message content (supports markdown). Can be null to clear text.

    The text field supports markdown formatting including bold, italic, headers, lists, code blocks, and links. Raw HTML is not allowed and all content is sanitized to prevent XSS attacks.

Responses

  • 201 application/json

    Message created successfully

    Hide response attributes Show response attributes object
    • id string

      Unique identifier for the message (format: msg_xxx)

    • requestId string

      The ID of the request this message belongs to

    • title string

      The title/subject of the message

    • text string | null

      The message content (supports markdown). Can be null if no text.

      Supports markdown formatting including bold text, italic text, headers, lists, code blocks, and links. Raw HTML is not allowed and all content is sanitized to prevent XSS attacks.

    • createdAt string(date-time)

      When the message was created (ISO 8601 format, UTC)

    • updatedAt string(date-time)

      When the message was last updated (ISO 8601 format, UTC)

  • 400

    Bad Request -- Your request is invalid.

  • 401

    Unauthorized -- Your API key is wrong.

  • 403

    Forbidden -- The object requested is hidden for administrators only.

  • 404

    Not Found -- The specified object could not be found.

  • 429

    Too Many Requests -- You're requesting too many objects! Slow down!

  • 500

    Internal Server Error -- We had a problem with our server. Try again later.

  • 503

    Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

POST /requests/{requestId}/messages
curl \
 --request POST 'https://api.usecollect.com/v1/requests/{requestId}/messages' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"text":"Here is the response generated by the agent...","title":"AI Agent - reply sent"}'
Request example
{
  "text": "Here is the response generated by the agent...",
  "title": "AI Agent - reply sent"
}
Response examples (201)
{
  "id": "msg_123",
  "text": "Here is the response generated by the agent...",
  "title": "AI Agent - reply sent",
  "createdAt": "2026-01-21T10:12:46Z",
  "requestId": "req_456",
  "updatedAt": "2026-01-21T10:12:46Z"
}