All URIs are relative to https://sync.api.docspring.com/api/v2

async fn add_template_fields(&self, params: AddTemplateFieldsParams) -> Result<models::TemplateFields, Error> Add fields to a template

Adds fields to a template's draft and returns all of its fields. Publish a version for submissions of published versions to have them.

Set them on AddTemplateFieldsParams::builder().

models::TemplateFields

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn copy_template(&self, params: CopyTemplateParams) -> Result<models::Template, Error> Copy a template

Copies a template (its draft, or a published version) into a new template.

Set them on CopyTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_combined_pdf(&self, params: CreateCombinedPdfParams) -> Result<models::CombinedPdf, Error> Combine PDFs

Merges PDFs into one: submissions, other combined PDFs, templates, custom files (POST /custom_files) and PDFs from URLs, in the order of source_pdfs. The PDF is generated in the background: on sync.api hosts the request waits for it (unless you pass wait=false), otherwise poll GET /combined_pdfs/{combined_pdf_id} until state isn't pending. A template source merges the template's processed PDF by default: the PDF submissions are filled in on, decrypted and with its form fields removed. Pass processed: false to merge the PDF as it was uploaded.

Set them on CreateCombinedPdfParams::builder().

models::CombinedPdf

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_custom_file_from_upload(&self, params: CreateCustomFileFromUploadParams) -> Result<models::CustomFile, Error> Create a custom file from an upload

Creates a custom file from a PDF you uploaded, so you can merge it with other PDFs. Upload the file with the presigned upload (GET /uploads/presign) first, then pass its fields.key as cache_id.

Set them on CreateCustomFileFromUploadParams::builder().

models::CustomFile

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_folder(&self, params: CreateFolderParams) -> Result<models::Folder, Error> Create a folder

Creates a folder for organizing templates. Pass parent_folder_id to create it inside another folder. Folder names are unique within their parent folder.

Set them on CreateFolderParams::builder().

models::Folder

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_signature_request_event(&self, params: CreateSignatureRequestEventParams) -> Result<models::SignatureRequestEvent, Error> Record a signature request event

Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (send_request). The audit trail shows it as reported by your account. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request.

Set them on CreateSignatureRequestEventParams::builder().

models::SignatureRequestEvent

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_signature_request_token(&self, params: CreateSignatureRequestTokenParams) -> Result<models::SignatureRequestToken, Error> Create a signature request token

Creates a token that opens the signature request without signing in, in a form embedded in your app or from a link you send. The response is the only time the token's secret is returned. The link works for 24 hours, or 7 days for an email token, and a signing page that opened in time keeps working for 7 more days. A test API token can't create a token for a live signature request.

Set them on CreateSignatureRequestTokenParams::builder().

models::SignatureRequestToken

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_submission(&self, params: CreateSubmissionParams) -> Result<models::Submission, Error> Generate a PDF

Creates a submission: fills in a template with your data and generates a PDF. The PDF is generated in the background: on sync.api hosts the request waits for it (unless you pass wait=false), otherwise poll GET /submissions/{submission_id} until state isn't pending. Data that doesn't match the template's fields returns a 422 with an invalid_data error. The submission is still saved, with its errors, so you can find it in DocSpring: the error's submission_id is its ID.

Set them on CreateSubmissionParams::builder().

models::Submission

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_submission_batch(&self, params: CreateSubmissionBatchParams) -> Result<models::SubmissionBatch, Error> Generate PDFs in a batch

Creates up to 50 submissions in one request, from one template or several. The PDFs are only generated when every submission is valid. On sync.api hosts the request waits until every PDF has been generated (unless you pass wait=false), otherwise poll GET /submissions/batches/{submission_batch_id} until processed_at is set. When any submission is invalid, nothing is generated and the request returns a 422. Submissions whose data doesn't match their template's fields are still saved with their errors (an invalid_data error, with each one's submission_id in its details), so you can find them in DocSpring. The other submissions aren't saved.

Set them on CreateSubmissionBatchParams::builder().

models::SubmissionBatch

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_template(&self, params: CreateTemplateParams) -> Result<models::Template, Error> Create a template

Creates an HTML template, or a PDF or Word template from a file you uploaded with the presigned upload (GET /uploads/presign): pass its fields.key as cache_id. You can send a link to the file (document_url) or the file in base64 (document_base64) instead, or send the file with the request with POST /templates/upload. A Word template is made from a Word document (.docx) or an OpenDocument text file (.odt), which DocSpring converts to a Word document. It needs its output_format: what each submission makes, a Word document (docx), an OpenDocument file (odt) or a PDF. A PDF template is ready to generate PDFs once DocSpring has processed its PDF, a template created from a document_url once its document has been downloaded, and one created from an .odt once it has been converted (ready is true). On sync.api hosts the request waits for that unless you pass wait=false.

Set them on CreateTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_template_preview(&self, params: CreateTemplatePreviewParams) -> Result<models::TemplatePreview, Error> Preview a template with data

Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML, PDF or Word template prints with your data before you publish a version or send live data. A Word template's pages are its PDF's, whatever its output_format. It renders the template's draft, or the published version you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's pending while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's processed, with an image of each page, or error.

Set them on CreateTemplatePreviewParams::builder().

models::TemplatePreview

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn create_webhook(&self, params: CreateWebhookParams) -> Result<models::Webhook, Error> Create a webhook

Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events.

Set them on CreateWebhookParams::builder().

models::Webhook

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn delete_custom_file(&self, params: DeleteCustomFileParams) -> Result<models::CustomFile, Error> Delete a custom file

Deletes a custom file and returns it. Use a live API token: test tokens can't delete custom files.

Set them on DeleteCustomFileParams::builder().

models::CustomFile

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn delete_folder(&self, params: DeleteFolderParams) -> Result<models::Folder, Error> Delete a folder

Deletes an empty folder and returns it. A folder that still has templates or folders in it can't be deleted.

Set them on DeleteFolderParams::builder().

models::Folder

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn delete_template(&self, params: DeleteTemplateParams) -> Result<models::Template, Error> Delete a template

Deletes a template's draft and all of its published versions, or one published version (version). Returns the template as it was before it was deleted.

Set them on DeleteTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn delete_webhook(&self, params: DeleteWebhookParams) -> Result<models::Webhook, Error> Delete a webhook

Deletes a webhook so it stops receiving events, and returns it.

Set them on DeleteWebhookParams::builder().

models::Webhook

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn expire_combined_pdf(&self, params: ExpireCombinedPdfParams) -> Result<models::CombinedPdf, Error> Expire a combined PDF

Deletes a combined PDF's PDF and returns the expired combined PDF.

Set them on ExpireCombinedPdfParams::builder().

models::CombinedPdf

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn expire_submission(&self, params: ExpireSubmissionParams) -> Result<models::Submission, Error> Expire a submission

Deletes a submission's data and PDF now, and returns the expired submission.

Set them on ExpireSubmissionParams::builder().

models::Submission

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn generate_submission_files(&self, params: GenerateSubmissionFilesParams) -> Result<models::Submission, Error> Generate more files

Adds formats to a processed submission's files, in the background, without using credits again: pdf, the PDF of a Word template's submission that made only its Word document (converted from that document), docx, the Word document of a Word template's submission that made only its PDF (made again from its data and the template version it used), odt, a Word template's submission's OpenDocument file (converted from its Word document, or from one made again when it didn't keep one), and png, a PNG image of each page of the PDF (up to 100 pages), which makes the PDF first when the submission doesn't have one. To make them with the submission, add them to output_formats when you create it. Each new file is listed in files while it's made: on sync.api hosts the request waits for them (unless you pass wait=false), otherwise poll GET /submissions/{submission_id} until none of their state is pending. A file that couldn't be made has the state error and an error_message, and the submission stays processed. Asking for a format the submission already has (or is making) changes nothing.

Set them on GenerateSubmissionFilesParams::builder().

models::Submission

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn generate_submission_preview(&self, params: GenerateSubmissionPreviewParams) -> Result<models::Submission, Error> Generate a preview PDF

Generates a preview of a submission's PDF in the background, such as for a submission still waiting for its signature requests. It's in files.preview once preview_generated_at changes.

Set them on GenerateSubmissionPreviewParams::builder().

models::Submission

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_combined_pdf(&self, params: GetCombinedPdfParams) -> Result<models::CombinedPdf, Error> Get a combined PDF

Returns a combined PDF, with a temporary link to download it once it has been generated.

Set them on GetCombinedPdfParams::builder().

models::CombinedPdf

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_custom_file(&self, params: GetCustomFileParams) -> Result<models::CustomFile, Error> Get a custom file

Returns a custom file, with a temporary URL to download it.

Set them on GetCustomFileParams::builder().

models::CustomFile

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_folder(&self, params: GetFolderParams) -> Result<models::Folder, Error> Get a folder

Returns a folder.

Set them on GetFolderParams::builder().

models::Folder

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_presign_url(&self) -> Result<models::UploadPresign, Error> Get a presigned URL to upload a file

Returns a presigned S3 form for uploading a file directly to DocSpring, for files too large to send in a request body. POST the fields and the file (as file) to url as multipart/form-data, then pass fields.key as the cache_id when you create a custom file.

This endpoint does not need any parameter.

models::UploadPresign

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_signature_request(&self, params: GetSignatureRequestParams) -> Result<models::SignatureRequest, Error> Get a signature request

Returns a signature request, with the values the person has entered so far.

Set them on GetSignatureRequestParams::builder().

models::SignatureRequest

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_submission(&self, params: GetSubmissionParams) -> Result<models::Submission, Error> Get a submission

Returns a submission, with its data and links to download its PDF.

Set them on GetSubmissionParams::builder().

models::Submission

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_submission_batch(&self, params: GetSubmissionBatchParams) -> Result<models::SubmissionBatch, Error> Get a batch

Returns a batch with its submissions. The batch has finished once processed_at is set: its state is processed when every PDF was generated, or error when any submission failed.

Set them on GetSubmissionBatchParams::builder().

models::SubmissionBatch

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template(&self, params: GetTemplateParams) -> Result<models::Template, Error> Get a template

Returns a template: its draft, or one of its published versions.

Set them on GetTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template_diff(&self, params: GetTemplateDiffParams) -> Result<models::TemplateDiff, Error> Compare a version of a template with the one before it

Returns what changed in the template's draft since its latest published version (or in a published version since the one before it): fields added, removed, changed and moved, the settings that changed, and whether the document was replaced. Check it before you publish a version.

Set them on GetTemplateDiffParams::builder().

models::TemplateDiff

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template_model_code(&self, params: GetTemplateModelCodeParams) -> Result<models::TemplateModelCode, Error> Generate typed code for a template's submission data

Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir, Go or Rust, so your app catches mistakes before it calls the API. root_type_name is the type of the whole data object, and just_types=true leaves out the code that converts JSON to and from the types. Java returns every class in code, each under a // ClassName.java comment. A template with no named fields returns 422.

Set them on GetTemplateModelCodeParams::builder().

models::TemplateModelCode

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template_page_images(&self, params: GetTemplatePageImagesParams) -> Result<models::TemplatePageImages, Error> Get images of a template's pages

Returns a JPEG image of each page of a PDF template's PDF, with temporary links to download them: the draft's PDF, or a published version's. Use them to see the pages that fields are placed on.

Set them on GetTemplatePageImagesParams::builder().

models::TemplatePageImages

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template_preview(&self, params: GetTemplatePreviewParams) -> Result<models::TemplatePreview, Error> Get a template preview

Returns a preview made with POST /templates/{template_id}/previews. Once it's processed, pages has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created.

Set them on GetTemplatePreviewParams::builder().

models::TemplatePreview

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_template_schema(&self, params: GetTemplateSchemaParams) -> Result<std::collections::HashMap<String, serde_json::Value>, Error> Get the JSON Schema of a template's submission data

Returns the JSON Schema that a submission's data must match. Use it to check data before you create submissions, or to build a form for the template's fields.

Set them on GetTemplateSchemaParams::builder().

std::collections::HashMap<String, serde_json::Value>

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn get_webhook(&self, params: GetWebhookParams) -> Result<models::Webhook, Error> Get a webhook

Returns a webhook.

Set them on GetWebhookParams::builder().

models::Webhook

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_combined_pdfs(&self, params: ListCombinedPdfsParams) -> Result<models::CombinedPdfList, Error> List combined PDFs

Returns the combined PDFs in your account, newest first, one page at a time.

Set them on ListCombinedPdfsParams::builder().

models::CombinedPdfList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_custom_files(&self, params: ListCustomFilesParams) -> Result<models::CustomFileList, Error> List custom files

Returns the custom files in your account, newest first, one page at a time.

Set them on ListCustomFilesParams::builder().

models::CustomFileList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_folders(&self, params: ListFoldersParams) -> Result<models::FolderList, Error> List folders

Returns the folders in your account, newest first, one page at a time. Pass parent_folder_id to list the folders in one folder.

Set them on ListFoldersParams::builder().

models::FolderList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_submissions(&self, params: ListSubmissionsParams) -> Result<models::SubmissionList, Error> List submissions

Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its data is null unless you pass include_data=true, and its files are empty unless you pass include_files=true. Get a submission by its ID for its signature requests, uploads and page images.

Set them on ListSubmissionsParams::builder().

models::SubmissionList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_template_fields(&self, params: ListTemplateFieldsParams) -> Result<models::TemplateFields, Error> List a template's fields

Returns a template's fields with all of their settings, page by page: the draft's fields, or a published version's. A PDF template's fields are placed on its pages: GET /templates/{template_id}/page_images has images of the pages.

Set them on ListTemplateFieldsParams::builder().

models::TemplateFields

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_template_submissions(&self, params: ListTemplateSubmissionsParams) -> Result<models::SubmissionList, Error> List a template's submissions

Returns a template's submissions (from every version of the template), newest first.

Set them on ListTemplateSubmissionsParams::builder().

models::SubmissionList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_templates(&self, params: ListTemplatesParams) -> Result<models::TemplateSummaryList, Error> List templates

Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, its HTML, defaults and published versions.

Set them on ListTemplatesParams::builder().

models::TemplateSummaryList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn list_webhooks(&self, params: ListWebhooksParams) -> Result<models::WebhookList, Error> List webhooks

Returns the webhooks in your account, newest first, one page at a time. Filter them by event type, mode, or the API token, template or folder they're scoped to.

Set them on ListWebhooksParams::builder().

models::WebhookList

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn move_folder(&self, params: MoveFolderParams) -> Result<models::Folder, Error> Move a folder

Moves a folder into another folder, or to the root with parent_folder_id: null. Its templates and folders move with it. A folder can't move into itself or one of its own folders.

Set them on MoveFolderParams::builder().

models::Folder

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn move_template(&self, params: MoveTemplateParams) -> Result<models::Template, Error> Move a template to a folder

Moves a template and all of its published versions to a folder, or to the root (null).

Set them on MoveTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn publish_template_version(&self, params: PublishTemplateVersionParams) -> Result<models::TemplateVersion, Error> Publish a template version

Publishes the template's draft as a new version. Its content (the PDF or HTML, fields, name and description) never changes, while settings such as webhook_url and public_submissions keep following the draft. version_type says which part of the latest version number goes up. While the template's PDF is downloading or being processed, or DocSpring is setting up its fields, it returns a 409 that says so.

Set them on PublishTemplateVersionParams::builder().

models::TemplateVersion

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn remove_template_fields(&self, params: RemoveTemplateFieldsParams) -> Result<models::TemplateFields, Error> Remove fields from a template

Removes fields from a template's draft and returns the fields that are left. Conditional logic that used only the removed fields is removed too.

Set them on RemoveTemplateFieldsParams::builder().

models::TemplateFields

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn rename_folder(&self, params: RenameFolderParams) -> Result<models::Folder, Error> Rename a folder

Renames a folder. The name must be unique within its parent folder.

Set them on RenameFolderParams::builder().

models::Folder

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn reorder_template_fields(&self, params: ReorderTemplateFieldsParams) -> Result<models::TemplateFields, Error> Reorder a template's fields

Changes the order of the fields in a template's draft and returns them in their new order. Send every field's ID: each field stays on its page, and a page's fields are printed in this order, so a later field prints over an earlier one where they overlap. Their values are in this order in the template's data schema and forms.

Set them on ReorderTemplateFieldsParams::builder().

models::TemplateFields

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn restore_template_version(&self, params: RestoreTemplateVersionParams) -> Result<models::Template, Error> Restore a template version

Replaces the template's draft with a copy of one of its published versions. The draft keeps its settings that apply to every version, such as webhook_url.

Set them on RestoreTemplateVersionParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn test_authentication(&self) -> Result<models::AuthenticationCheck, Error> Test authentication

Checks whether your API token is valid by making an authenticated request. This endpoint is useful for verifying credentials during setup or troubleshooting issues.

This endpoint does not need any parameter.

models::AuthenticationCheck

api_token_basic

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn update_signature_request(&self, params: UpdateSignatureRequestParams) -> Result<models::SignatureRequest, Error> Update a signature request

Changes a pending signature request's metadata, or how your app authenticated the person (for the audit trail). Once the person has opened it, only its metadata can be changed, and a completed or declined signature request can't be changed.

Set them on UpdateSignatureRequestParams::builder().

models::SignatureRequest

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn update_template(&self, params: UpdateTemplateParams) -> Result<models::Template, Error> Update a template

Changes a template's draft. Properties left out keep their values. defaults and html_engine_options replace the whole object, and field_groups changes only the groups it lists. Settings such as webhook_url, public_submissions and expire_after apply to every published version too, and setting parent_folder_id moves the template and all of its published versions.

Set them on UpdateTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn update_template_document(&self, params: UpdateTemplateDocumentParams) -> Result<models::Template, Error> Replace a template's document

Replaces a PDF template's PDF, or a Word template's Word document (from a .docx or an .odt), with one you uploaded with the presigned upload (GET /uploads/presign) (cache_id), a link to download it from (document_url), or the file in base64 (document_base64). A PDF template's fields stay where they are, unless reimport_fields replaces them with the new PDF's fillable fields, and a Word template gets a field for each new tag. To send the file as multipart/form-data instead, use PUT /templates/{template_id}/document/upload.

Set them on UpdateTemplateDocumentParams::builder().

models::Template

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn update_template_fields(&self, params: UpdateTemplateFieldsParams) -> Result<models::TemplateFields, Error> Update a template's fields

Changes fields of a template's draft and returns all of its fields. Settings left out keep their values. A shared setting (type, required, default, ...) changes for every field with the same name.

Set them on UpdateTemplateFieldsParams::builder().

models::TemplateFields

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn update_webhook(&self, params: UpdateWebhookParams) -> Result<models::Webhook, Error> Update a webhook

Updates a webhook. Only the properties you send change.

Set them on UpdateWebhookParams::builder().

models::Webhook

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn upload_template(&self, params: UploadTemplateParams) -> Result<models::Template, Error> Create a template from an uploaded PDF or Word document

Creates a PDF template from a PDF, or a Word template from a Word document (.docx) or an OpenDocument text file (.odt), sent with the request (multipart/form-data). A Word template needs its output_format. For large files, upload the file with the presigned upload (GET /uploads/presign) and create the template with POST /templates.

Set them on UploadTemplateParams::builder().

models::Template

api_token_basic

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn upload_template_document(&self, params: UploadTemplateDocumentParams) -> Result<models::Template, Error> Replace a template's document with an uploaded file

Replaces a PDF template's PDF, or a Word template's Word document, with one sent with the request (multipart/form-data). A PDF template's fields stay where they are, unless reimport_fields replaces them with the new PDF's fillable fields, and a Word template gets a field for each new tag.

Set them on UploadTemplateDocumentParams::builder().

models::Template

api_token_basic

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

async fn validate_submission(&self, params: ValidateSubmissionParams) -> Result<models::SubmissionValidation, Error> Check a submission without creating it

Checks a submission as creating it would (its data against the template's fields, its settings and signature requests) without saving it, generating anything or using credits. It doesn't check your account's credits. The response says whether the submission is valid, and if not, has the error that creating it would return.

Set them on ValidateSubmissionParams::builder().

models::SubmissionValidation

api_token_basic

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]