add_recipient
Add a signer, approver, or CC recipient to a digital signature envelope by specifying their role, name, and email.
Instructions
Add a signer, approver, or CC recipient to an envelope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | Envelope UUID | |
| role | Yes | Recipient role | |
| name | Yes | Recipient full name | |
| Yes | Recipient email | ||
| mobile | No | Mobile phone (e.g. +420111222333) |
Implementation Reference
- src/api.js:147-151 (handler)The API function that performs the network request to add a recipient to an envelope.
export function addRecipient(creds, envelopeId, { role, name, email, mobile }) { const body = { role, name, email }; if (mobile) body.mobile = mobile; return apiCall('POST', `/api/envelopes/${envelopeId}/recipients`, { ...creds, body }); } - src/index.js:202-220 (registration)The MCP tool definition and handler for 'add_recipient', which calls the underlying API function.
server.tool( 'add_recipient', 'Add a signer, approver, or CC recipient to an envelope.', { envelopeId: z.string().describe('Envelope UUID'), role: z.enum(['signer', 'in_person', 'cc', 'approver']).describe('Recipient role'), name: z.string().describe('Recipient full name'), email: z.string().describe('Recipient email'), mobile: z.string().optional().describe('Mobile phone (e.g. +420111222333)'), }, async ({ envelopeId, ...recipient }) => { try { const data = await api.addRecipient(creds, envelopeId, recipient); return result(data); } catch (err) { return errorResult(err); } } ); - src/index.js:205-211 (schema)The Zod schema defining the input parameters for the 'add_recipient' tool.
{ envelopeId: z.string().describe('Envelope UUID'), role: z.enum(['signer', 'in_person', 'cc', 'approver']).describe('Recipient role'), name: z.string().describe('Recipient full name'), email: z.string().describe('Recipient email'), mobile: z.string().optional().describe('Mobile phone (e.g. +420111222333)'), },