149 lines
4.0 KiB
Markdown
149 lines
4.0 KiB
Markdown
---
|
|
name: client-routes
|
|
description: Handle 11 OpenAPI operation(s) under /client for the client route group.
|
|
---
|
|
|
|
# client API Routes
|
|
|
|
Handle 11 OpenAPI operation(s) under /client for the client 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_client_review_values_reports
|
|
|
|
- Operation ID: `get_client_review_values_reports`
|
|
- Route: `GET /client/review-values-reports`
|
|
- Mode: READ
|
|
- Summary: Get Client Review Values Reports
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `fields[review-values-report]` in `query`
|
|
- `filter` in `query`
|
|
- `group_by` in `query` required
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `statistics` in `query` required
|
|
- `timeframe` in `query` required
|
|
- `revision` in `header` required
|
|
|
|
### get_client_reviews
|
|
|
|
- Operation ID: `get_client_reviews`
|
|
- Route: `GET /client/reviews`
|
|
- Mode: READ
|
|
- Summary: Get Client Reviews
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `fields[review]` in `query`
|
|
- `filter` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `sort` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_client_review
|
|
|
|
- Operation ID: `create_client_review`
|
|
- Route: `POST /client/reviews`
|
|
- Mode: WRITE
|
|
- Summary: Create Client Review
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_client_geofences
|
|
|
|
- Operation ID: `get_client_geofences`
|
|
- Route: `GET /client/geofences`
|
|
- Mode: READ
|
|
- Summary: Get Client Geofences
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `fields[geofence]` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `page[size]` in `query`
|
|
- `X-Klaviyo-API-Filters` in `header`
|
|
- `revision` in `header` required
|
|
|
|
### create_client_subscription
|
|
|
|
- Operation ID: `create_client_subscription`
|
|
- Route: `POST /client/subscriptions`
|
|
- Mode: WRITE
|
|
- Summary: Create Client Subscription
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_client_push_token
|
|
|
|
- Operation ID: `create_client_push_token`
|
|
- Route: `POST /client/push-tokens`
|
|
- Mode: WRITE
|
|
- Summary: Create or Update Client Push Token
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### unregister_client_push_token
|
|
|
|
- Operation ID: `unregister_client_push_token`
|
|
- Route: `POST /client/push-token-unregister`
|
|
- Mode: WRITE
|
|
- Summary: Unregister Client Push Token
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_client_event
|
|
|
|
- Operation ID: `create_client_event`
|
|
- Route: `POST /client/events`
|
|
- Mode: WRITE
|
|
- Summary: Create Client Event
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_client_profile
|
|
|
|
- Operation ID: `create_client_profile`
|
|
- Route: `POST /client/profiles`
|
|
- Mode: WRITE
|
|
- Summary: Create or Update Client Profile
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_create_client_events
|
|
|
|
- Operation ID: `bulk_create_client_events`
|
|
- Route: `POST /client/event-bulk-create`
|
|
- Mode: WRITE
|
|
- Summary: Bulk Create Client Events
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_client_back_in_stock_subscription
|
|
|
|
- Operation ID: `create_client_back_in_stock_subscription`
|
|
- Route: `POST /client/back-in-stock-subscriptions`
|
|
- Mode: WRITE
|
|
- Summary: Create Client Back In Stock Subscription
|
|
- Parameters:
|
|
- `company_id` in `query` required
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|