63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
---
|
|
name: sign-requests-routes
|
|
description: Handle 5 OpenAPI operation(s) under /sign_requests for the sign requests route group.
|
|
---
|
|
|
|
# sign requests API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /sign_requests for the sign requests 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_sign_requests_id_cancel
|
|
|
|
- Operation ID: `post_sign_requests_id_cancel`
|
|
- Route: `POST /sign_requests/{sign_request_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel Box Sign request
|
|
- Parameters:
|
|
- `sign_request_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_sign_requests_id_resend
|
|
|
|
- Operation ID: `post_sign_requests_id_resend`
|
|
- Route: `POST /sign_requests/{sign_request_id}/resend`
|
|
- Mode: WRITE
|
|
- Summary: Resend Box Sign request
|
|
- Parameters:
|
|
- `sign_request_id` in `path` required
|
|
|
|
### get_sign_requests_id
|
|
|
|
- Operation ID: `get_sign_requests_id`
|
|
- Route: `GET /sign_requests/{sign_request_id}`
|
|
- Mode: READ
|
|
- Summary: Get Box Sign request by ID
|
|
- Parameters:
|
|
- `sign_request_id` in `path` required
|
|
|
|
### get_sign_requests
|
|
|
|
- Operation ID: `get_sign_requests`
|
|
- Route: `GET /sign_requests`
|
|
- Mode: READ
|
|
- Summary: List Box Sign requests
|
|
- Parameters:
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
- `senders` in `query`
|
|
- `shared_requests` in `query`
|
|
|
|
### post_sign_requests
|
|
|
|
- Operation ID: `post_sign_requests`
|
|
- Route: `POST /sign_requests`
|
|
- Mode: WRITE
|
|
- Summary: Create Box Sign request
|
|
- Body: JSON request body accepted.
|