73 lines
1.6 KiB
Markdown
73 lines
1.6 KiB
Markdown
---
|
|
name: campaigns-routes
|
|
description: Handle 6 OpenAPI operation(s) under /campaigns for the campaigns route group.
|
|
---
|
|
|
|
# campaigns API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /campaigns for the campaigns 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
|
|
|
|
### campaigns_list
|
|
|
|
- Operation ID: `campaigns_list`
|
|
- Route: `GET /campaigns`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `include` in `query`
|
|
- `before/after` in `query`
|
|
|
|
### campaign_create
|
|
|
|
- Operation ID: `campaign_create`
|
|
- Route: `POST /campaigns`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Parameters:
|
|
- `x-lang-output` in `header`
|
|
- Body: JSON request body accepted.
|
|
|
|
### campaign_retrieve
|
|
|
|
- Operation ID: `campaign_retrieve`
|
|
- Route: `GET /campaigns/{cmp_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `cmp_id` in `path` required
|
|
|
|
### campaign_update
|
|
|
|
- Operation ID: `campaign_update`
|
|
- Route: `PATCH /campaigns/{cmp_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `cmp_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### campaign_delete
|
|
|
|
- Operation ID: `campaign_delete`
|
|
- Route: `DELETE /campaigns/{cmp_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `cmp_id` in `path` required
|
|
|
|
### campaign_send
|
|
|
|
- Operation ID: `campaign_send`
|
|
- Route: `POST /campaigns/{cmp_id}/send`
|
|
- Mode: WRITE
|
|
- Summary: Send Campaign
|
|
- Parameters:
|
|
- `cmp_id` in `path` required
|