diff --git a/packages/api/v1/contract.ts b/packages/api/v1/contract.ts index cd90c31c4..c21358c28 100644 --- a/packages/api/v1/contract.ts +++ b/packages/api/v1/contract.ts @@ -168,6 +168,9 @@ export const ApiContractV1 = c.router( 500: ZUnsuccessfulResponseSchema, }, summary: 'Send a document for signing', + // I'm aware this should be in the variable itself, which it is, however it's difficult for users to find in our current UI. + description: + 'Notes\n\n`sendEmail` - Whether to send an email to the recipients asking them to action the document. If you disable this, you will need to manually distribute the document to the recipients using the generated signing links. Defaults to true', }, resendDocument: { diff --git a/packages/api/v1/schema.ts b/packages/api/v1/schema.ts index a4fab1089..87e17ba8b 100644 --- a/packages/api/v1/schema.ts +++ b/packages/api/v1/schema.ts @@ -67,7 +67,10 @@ export type TSuccessfulDocumentResponseSchema = z.infer ({ sendEmail: true })));