klaviyo-openapi-agent/skills/segments/SKILL.md

name, description

name	description
segments-routes	Handle 11 OpenAPI operation(s) under /api/segments for the segments route group.

segments API Routes

Handle 11 OpenAPI operation(s) under /api/segments for the segments 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_segments

• Operation ID: get_segments
• Route: GET /api/segments
• Mode: READ
• Summary: Get Segments
• Parameters:
  • fields[flow] in query
  • fields[segment] in query
  • fields[tag] in query
  • filter in query
  • include in query
  • page[cursor] in query
  • page[size] in query
  • sort in query
  • revision in header required

create_segment

• Operation ID: create_segment
• Route: POST /api/segments
• Mode: WRITE
• Summary: Create Segment
• Parameters:
  • fields[segment] in query
  • revision in header required
• Body: JSON request body accepted.

get_segment

• Operation ID: get_segment
• Route: GET /api/segments/{id}
• Mode: READ
• Summary: Get Segment
• Parameters:
  • id in path required
  • additional-fields[segment] in query
  • fields[flow] in query
  • fields[segment] in query
  • fields[tag] in query
  • include in query
  • revision in header required

update_segment

• Operation ID: update_segment
• Route: PATCH /api/segments/{id}
• Mode: WRITE
• Summary: Update Segment
• Parameters:
  • id in path required
  • fields[segment] in query
  • revision in header required
• Body: JSON request body accepted.

delete_segment

• Operation ID: delete_segment
• Route: DELETE /api/segments/{id}
• Mode: WRITE
• Summary: Delete Segment
• Parameters:
  • id in path required
  • revision in header required

get_tags_for_segment

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

get_tag_ids_for_segment

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

get_profiles_for_segment

• Operation ID: get_profiles_for_segment
• Route: GET /api/segments/{id}/profiles
• Mode: READ
• Summary: Get Profiles for Segment
• Parameters:
  • id in path required
  • additional-fields[profile] in query
  • fields[profile] in query
  • filter in query
  • page[cursor] in query
  • page[size] in query
  • sort in query
  • revision in header required

get_profile_ids_for_segment

• Operation ID: get_profile_ids_for_segment
• Route: GET /api/segments/{id}/relationships/profiles
• Mode: READ
• Summary: Get Profile IDs for Segment
• Parameters:
  • id in path required
  • filter in query
  • page[cursor] in query
  • page[size] in query
  • sort in query
  • revision in header required

get_flows_triggered_by_segment

• Operation ID: get_flows_triggered_by_segment
• Route: GET /api/segments/{id}/flow-triggers
• Mode: READ
• Summary: Get Flows Triggered by Segment
• Parameters:
  • id in path required
  • fields[flow] in query
  • revision in header required

get_ids_for_flows_triggered_by_segment

• Operation ID: get_ids_for_flows_triggered_by_segment
• Route: GET /api/segments/{id}/relationships/flow-triggers
• Mode: READ
• Summary: Get IDs for Flows Triggered by Segment
• Parameters:
  • id in path required
  • revision in header required