1.5 KiB
1.5 KiB
name, description
| name | description |
|---|---|
| letters-routes | Handle 4 OpenAPI operation(s) under /letters for the letters route group. |
letters API Routes
Handle 4 OpenAPI operation(s) under /letters for the letters 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
letter_retrieve
- Operation ID:
letter_retrieve - Route:
GET /letters/{ltr_id} - Mode: READ
- Summary: Retrieve
- Parameters:
ltr_idinpathrequired
letter_cancel
- Operation ID:
letter_cancel - Route:
DELETE /letters/{ltr_id} - Mode: WRITE
- Summary: Cancel
- Parameters:
ltr_idinpathrequired
letters_list
- Operation ID:
letters_list - Route:
GET /letters - Mode: READ
- Summary: List
- Parameters:
limitinquerybefore/afterinqueryincludeinquerydate_createdinquerymetadatainquerycampaign_idinquerystatusinquerycolorinqueryscheduledinquerysend_dateinquerymail_typeinquerysort_byinquery
letter_create
- Operation ID:
letter_create - Route:
POST /letters - Mode: WRITE
- Summary: Create
- Parameters:
Idempotency-Keyinheaderidempotency_keyinqueryLob-Versioninheader
- Body: JSON request body accepted.