117 lines
3.0 KiB
Markdown
117 lines
3.0 KiB
Markdown
---
|
|
name: contacts-routes
|
|
description: Handle 10 OpenAPI operation(s) under /contacts for the contacts route group.
|
|
---
|
|
|
|
# contacts API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /contacts for the contacts 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
|
|
|
|
### post_contacts
|
|
|
|
- Operation ID: `post_contacts`
|
|
- Route: `POST /contacts`
|
|
- Mode: WRITE
|
|
- Summary: Create a new contact
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_contacts
|
|
|
|
- Operation ID: `get_contacts`
|
|
- Route: `GET /contacts`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of contacts
|
|
- Parameters:
|
|
- `segment_id` in `query`
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### get_contacts_id
|
|
|
|
- Operation ID: `get_contacts_id`
|
|
- Route: `GET /contacts/{id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a single contact by ID or email
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### patch_contacts_id
|
|
|
|
- Operation ID: `patch_contacts_id`
|
|
- Route: `PATCH /contacts/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update a single contact by ID or email
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_contacts_id
|
|
|
|
- Operation ID: `delete_contacts_id`
|
|
- Route: `DELETE /contacts/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove an existing contact by ID or email
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### get_contacts_contact_id_segments
|
|
|
|
- Operation ID: `get_contacts_contact_id_segments`
|
|
- Route: `GET /contacts/{contact_id}/segments`
|
|
- Mode: READ
|
|
- Summary: Retrieve a list of segments for a contact
|
|
- Parameters:
|
|
- `contact_id` in `path` required
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### post_contacts_contact_id_segments_segment_id
|
|
|
|
- Operation ID: `post_contacts_contact_id_segments_segment_id`
|
|
- Route: `POST /contacts/{contact_id}/segments/{segment_id}`
|
|
- Mode: WRITE
|
|
- Summary: Add a contact to a segment
|
|
- Parameters:
|
|
- `contact_id` in `path` required
|
|
- `segment_id` in `path` required
|
|
|
|
### delete_contacts_contact_id_segments_segment_id
|
|
|
|
- Operation ID: `delete_contacts_contact_id_segments_segment_id`
|
|
- Route: `DELETE /contacts/{contact_id}/segments/{segment_id}`
|
|
- Mode: WRITE
|
|
- Summary: Remove a contact from a segment
|
|
- Parameters:
|
|
- `contact_id` in `path` required
|
|
- `segment_id` in `path` required
|
|
|
|
### get_contacts_contact_id_topics
|
|
|
|
- Operation ID: `get_contacts_contact_id_topics`
|
|
- Route: `GET /contacts/{contact_id}/topics`
|
|
- Mode: READ
|
|
- Summary: Retrieve topics for a contact
|
|
- Parameters:
|
|
- `contact_id` in `path` required
|
|
- `limit` in `query`
|
|
- `after` in `query`
|
|
- `before` in `query`
|
|
|
|
### patch_contacts_contact_id_topics
|
|
|
|
- Operation ID: `patch_contacts_contact_id_topics`
|
|
- Route: `PATCH /contacts/{contact_id}/topics`
|
|
- Mode: WRITE
|
|
- Summary: Update topics for a contact
|
|
- Parameters:
|
|
- `contact_id` in `path` required
|
|
- Body: JSON request body accepted.
|