63 lines
1.4 KiB
Markdown
63 lines
1.4 KiB
Markdown
---
|
|
name: links-routes
|
|
description: Handle 5 OpenAPI operation(s) under /links for the links route group.
|
|
---
|
|
|
|
# links API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /links for the links 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
|
|
|
|
### links_get
|
|
|
|
- Operation ID: `links_get`
|
|
- Route: `GET /links/{link_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a link
|
|
- Parameters:
|
|
- `link_id` in `path` required
|
|
|
|
### link_update
|
|
|
|
- Operation ID: `link_update`
|
|
- Route: `PATCH /links/{link_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update a Link
|
|
- Parameters:
|
|
- `link_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### links_delete
|
|
|
|
- Operation ID: `links_delete`
|
|
- Route: `DELETE /links/{link_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Link
|
|
- Parameters:
|
|
- `link_id` in `path` required
|
|
|
|
### link_create
|
|
|
|
- Operation ID: `link_create`
|
|
- Route: `POST /links`
|
|
- Mode: WRITE
|
|
- Summary: Create Link
|
|
- Body: JSON request body accepted.
|
|
|
|
### links_list
|
|
|
|
- Operation ID: `links_list`
|
|
- Route: `GET /links`
|
|
- Mode: READ
|
|
- Summary: List all links
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `campaign_id` in `query`
|
|
- `domain_id` in `query`
|