chatwoot/swagger
Sojan Jose 33dea83716
docs: document message attachment uploads (#14600)
Updates the Create New Message API documentation to explain how to send
file attachments with multipart form data.

Closes #10472
Closes #12672

## Why

The endpoint already accepts attachment uploads, but the published API
docs only described the JSON request body. That made it unclear that
clients need to use multipart form data and send files through the
`attachments[]` field.

## What changed

- Adds `multipart/form-data` as a documented request body option for
Create New Message.
- Documents the `attachments` binary array and form encoding used by
`attachments[]`.
- Adds a multipart cURL request example for a message with an
attachment.
- Regenerates the Swagger JSON artifacts.

## Screenshots

Create New Message API docs with the multipart cURL sample and
`multipart/form-data` request sample selected:

<img width="1702" height="1083"
alt="create-message-attachment-docs-multipart"
src="https://github.com/user-attachments/assets/5fef9082-6eb9-494d-91d1-8dc0b7880212"
/>

## How to test

1. Open `/swagger`.
2. Navigate to Application -> Messages -> Create New Message.
3. Confirm the endpoint documents both `application/json` and
`multipart/form-data`, including the attachment payload schema.
2026-06-02 14:33:02 +05:30
..
definitions docs: Document API inbox webhook URL (#14593) 2026-06-01 12:37:07 +04:00
parameters feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
paths docs: document message attachment uploads (#14600) 2026-06-02 14:33:02 +05:30
tag_groups docs: document message attachment uploads (#14600) 2026-06-02 14:33:02 +05:30
index.html chore: Update report documentation (#13408) 2026-01-30 22:33:03 +04:00
index.yml docs(swagger): document account label endpoints (#13760) 2026-03-10 22:24:16 -07:00
swagger.json docs: document message attachment uploads (#14600) 2026-06-02 14:33:02 +05:30