48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
---
|
|
name: campaign-send-jobs-routes
|
|
description: Handle 3 OpenAPI operation(s) under /api/campaign-send-jobs for the campaign send jobs route group.
|
|
---
|
|
|
|
# campaign send jobs API Routes
|
|
|
|
Handle 3 OpenAPI operation(s) under /api/campaign-send-jobs for the campaign send jobs 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
|
|
|
|
### get_campaign_send_job
|
|
|
|
- Operation ID: `get_campaign_send_job`
|
|
- Route: `GET /api/campaign-send-jobs/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Campaign Send Job
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[campaign-send-job]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### cancel_campaign_send
|
|
|
|
- Operation ID: `cancel_campaign_send`
|
|
- Route: `PATCH /api/campaign-send-jobs/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Cancel Campaign Send
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### send_campaign
|
|
|
|
- Operation ID: `send_campaign`
|
|
- Route: `POST /api/campaign-send-jobs`
|
|
- Mode: WRITE
|
|
- Summary: Send Campaign
|
|
- Parameters:
|
|
- `fields[campaign-send-job]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|