72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
---
|
|
name: broadcasts-routes
|
|
description: Handle 6 OpenAPI operation(s) under /broadcasts for the broadcasts route group.
|
|
---
|
|
|
|
# broadcasts API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /broadcasts for the broadcasts route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### post_broadcasts
|
|
|
|
- Operation ID: `post_broadcasts`
|
|
- Route: `POST /broadcasts`
|
|
- Mode: WRITE
|
|
- Summary: Create a broadcast
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_broadcasts
|
|
|
|
- Operation ID: `get_broadcasts`
|
|
- Route: `GET /broadcasts`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of broadcasts
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### delete_broadcasts_id
|
|
|
|
- Operation ID: `delete_broadcasts_id`
|
|
- Route: `DELETE /broadcasts/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove an existing broadcast that is in the draft status
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### get_broadcasts_id
|
|
|
|
- Operation ID: `get_broadcasts_id`
|
|
- Route: `GET /broadcasts/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single broadcast
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### patch_broadcasts_id
|
|
|
|
- Operation ID: `patch_broadcasts_id`
|
|
- Route: `PATCH /broadcasts/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update an existing broadcast
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_broadcasts_id_send
|
|
|
|
- Operation ID: `post_broadcasts_id_send`
|
|
- Route: `POST /broadcasts/{id}/send`
|
|
- Mode: WRITE
|
|
- Summary: Send or schedule a broadcast
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|