Files
a2a-platform 15ec8b1d74 deploy
2026-06-27 01:03:04 +00:00

3.1 KiB

name, description
name description
campaigns-routes Handle 9 OpenAPI operation(s) under /api/campaigns for the campaigns route group.

campaigns API Routes

Handle 9 OpenAPI operation(s) under /api/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

get_campaigns

  • Operation ID: get_campaigns
  • Route: GET /api/campaigns
  • Mode: READ
  • Summary: Get Campaigns
  • Parameters:
    • fields[campaign-message] in query
    • fields[campaign] in query
    • fields[tag] in query
    • filter in query required
    • include in query
    • page[cursor] in query
    • page[size] in query
    • sort in query
    • revision in header required

create_campaign

  • Operation ID: create_campaign
  • Route: POST /api/campaigns
  • Mode: WRITE
  • Summary: Create Campaign
  • Parameters:
    • fields[campaign] in query
    • revision in header required
  • Body: JSON request body accepted.

get_campaign

  • Operation ID: get_campaign
  • Route: GET /api/campaigns/{id}
  • Mode: READ
  • Summary: Get Campaign
  • Parameters:
    • id in path required
    • fields[campaign-message] in query
    • fields[campaign] in query
    • fields[tag] in query
    • include in query
    • revision in header required

update_campaign

  • Operation ID: update_campaign
  • Route: PATCH /api/campaigns/{id}
  • Mode: WRITE
  • Summary: Update Campaign
  • Parameters:
    • id in path required
    • fields[campaign] in query
    • revision in header required
  • Body: JSON request body accepted.

delete_campaign

  • Operation ID: delete_campaign
  • Route: DELETE /api/campaigns/{id}
  • Mode: WRITE
  • Summary: Delete Campaign
  • Parameters:
    • id in path required
    • revision in header required

get_tags_for_campaign

  • Operation ID: get_tags_for_campaign
  • Route: GET /api/campaigns/{id}/tags
  • Mode: READ
  • Summary: Get Tags for Campaign
  • Parameters:
    • id in path required
    • fields[tag] in query
    • revision in header required

get_tag_ids_for_campaign

  • Operation ID: get_tag_ids_for_campaign
  • Route: GET /api/campaigns/{id}/relationships/tags
  • Mode: READ
  • Summary: Get Tag IDs for Campaign
  • Parameters:
    • id in path required
    • revision in header required

get_messages_for_campaign

  • Operation ID: get_messages_for_campaign
  • Route: GET /api/campaigns/{id}/campaign-messages
  • Mode: READ
  • Summary: Get Messages for Campaign
  • Parameters:
    • id in path required
    • fields[campaign-message] in query
    • fields[campaign] in query
    • fields[image] in query
    • fields[template] in query
    • include in query
    • revision in header required

get_message_ids_for_campaign

  • Operation ID: get_message_ids_for_campaign
  • Route: GET /api/campaigns/{id}/relationships/campaign-messages
  • Mode: READ
  • Summary: Get Message IDs for Campaign
  • Parameters:
    • id in path required
    • revision in header required