Box ACTION
Create Box Sign Request
Creates a Box Sign signature request and sends it to the listed signers. Requires at least one signer, plus the document(s) to sign passed via
Additional Options — either source_files (e.g. [{"id": "123456789", "type": "file"}]) or a template_id; Box rejects requests with no document source. The signed document and signing log are saved to the Parent Folder. See the documentation.- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Box account once, then configure and run Create Box Sign Request from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "box-create-sign-request",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
box: { authProvisionId: "apn_xxxxxxx" },
signers: ["Signers"],
name: "Request Name",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "box-create-sign-request",
"configured_props": {
"box": { "authProvisionId": "apn_xxxxxxx" },
"signers": ["Signers"],
"name": "Request Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "box",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "box-create-sign-request",
arguments: {
signers: ["Signers"],
name: "Request Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
signers Signers | string[] | Array of signers for the signature request. Each signer should be a JSON object with at least an email property. Valid roles: signer, approver, final_copy_reader (defaults to signer). See the documentation for more information. Example: {"email": "signer@example.com", "role": "signer"} Required |
name Request Name | string | Name of the signature request Optional |
parentFolder Parent Folder | string | The destination folder to place the final, signed document and signing log. Box does not allow the root folder ( 0) here — do not pass 0. Leave this empty and Box picks the default: the parent folder of the first source file when it has permission to upload there, otherwise a folder called My Sign Requests. Use the List Folders action to retrieve folder IDs. Optional Dynamic |
emailSubject Email Subject | string | Subject of sign request email. If not provided, a default subject will be used Optional |
emailMessage Email Message | string | Message to include in sign request email. If not provided, a default message will be used Optional |
redirectUrl Redirect URL | string | The URI that a signer will be redirected to after signing a document Optional |
declinedRedirectUrl Declined Redirect URL | string | The URI that a signer will be redirected to after declining to sign a document Optional |
additionalOptions Additional Options | object | Additional parameters to send in the request. See the documentation for all available parameters. Values will be parsed as JSON where applicable Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- box-create-sign-request
- Version
- 0.0.9
- App
- Box
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗