3.4 KiB
3.4 KiB
name, description
| name | description |
|---|---|
| campaign-messages-routes | Handle 9 OpenAPI operation(s) under /api/campaign-messages/{id} for the campaign messages route group. |
campaign messages API Routes
Handle 9 OpenAPI operation(s) under /api/campaign-messages/{id} for the campaign messages 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_message
- Operation ID:
get_campaign_message - Route:
GET /api/campaign-messages/{id} - Mode: READ
- Summary: Get Campaign Message
- Parameters:
idinpathrequiredfields[campaign-message]inqueryfields[campaign]inqueryfields[image]inqueryfields[template]inqueryincludeinqueryrevisioninheaderrequired
update_campaign_message
- Operation ID:
update_campaign_message - Route:
PATCH /api/campaign-messages/{id} - Mode: WRITE
- Summary: Update Campaign Message
- Parameters:
idinpathrequiredfields[campaign-message]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_campaign_for_campaign_message
- Operation ID:
get_campaign_for_campaign_message - Route:
GET /api/campaign-messages/{id}/campaign - Mode: READ
- Summary: Get Campaign for Campaign Message
- Parameters:
idinpathrequiredfields[campaign]inqueryrevisioninheaderrequired
get_campaign_id_for_campaign_message
- Operation ID:
get_campaign_id_for_campaign_message - Route:
GET /api/campaign-messages/{id}/relationships/campaign - Mode: READ
- Summary: Get Campaign ID for Campaign Message
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_template_for_campaign_message
- Operation ID:
get_template_for_campaign_message - Route:
GET /api/campaign-messages/{id}/template - Mode: READ
- Summary: Get Template for Campaign Message
- Parameters:
idinpathrequiredfields[template]inqueryrevisioninheaderrequired
get_template_id_for_campaign_message
- Operation ID:
get_template_id_for_campaign_message - Route:
GET /api/campaign-messages/{id}/relationships/template - Mode: READ
- Summary: Get Template ID for Campaign Message
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_image_for_campaign_message
- Operation ID:
get_image_for_campaign_message - Route:
GET /api/campaign-messages/{id}/image - Mode: READ
- Summary: Get Image for Campaign Message
- Parameters:
idinpathrequiredfields[image]inqueryrevisioninheaderrequired
get_image_id_for_campaign_message
- Operation ID:
get_image_id_for_campaign_message - Route:
GET /api/campaign-messages/{id}/relationships/image - Mode: READ
- Summary: Get Image ID for Campaign Message
- Parameters:
idinpathrequiredrevisioninheaderrequired
update_image_for_campaign_message
- Operation ID:
update_image_for_campaign_message - Route:
PATCH /api/campaign-messages/{id}/relationships/image - Mode: WRITE
- Summary: Update Image for Campaign Message
- Parameters:
idinpathrequiredrevisioninheaderrequired
- Body: JSON request body accepted.