998 lines
33 KiB
Markdown
998 lines
33 KiB
Markdown
---
|
|
name: accounts-2-routes
|
|
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 2 route group.
|
|
---
|
|
|
|
# accounts 2 API Routes
|
|
|
|
Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 2 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
|
|
|
|
### account_custom_fields_put_account_custom_fields
|
|
|
|
- Operation ID: `account_custom_fields_put_account_custom_fields`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates an account custom field.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `customFieldId` in `path` required
|
|
- `apply_to_templates` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### account_custom_fields_delete_account_custom_fields
|
|
|
|
- Operation ID: `account_custom_fields_delete_account_custom_fields`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes an account custom field.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `customFieldId` in `path` required
|
|
- `apply_to_templates` in `query`
|
|
|
|
### envelopes_get_envelopes
|
|
|
|
- Operation ID: `envelopes_get_envelopes`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes`
|
|
- Mode: READ
|
|
- Summary: Search for specific sets of envelopes by using search filters.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `ac_status` in `query`
|
|
- `block` in `query`
|
|
- `cdse_mode` in `query`
|
|
- `continuation_token` in `query`
|
|
- `count` in `query`
|
|
- `custom_field` in `query`
|
|
- `email` in `query`
|
|
- `envelope_ids` in `query`
|
|
- `exclude` in `query`
|
|
- `folder_ids` in `query`
|
|
- `folder_types` in `query`
|
|
- `from_date` in `query`
|
|
- `from_to_status` in `query`
|
|
- `include` in `query`
|
|
- `include_purge_information` in `query`
|
|
- `intersecting_folder_ids` in `query`
|
|
- `last_queried_date` in `query`
|
|
- `order` in `query`
|
|
- `order_by` in `query`
|
|
- `powerformids` in `query`
|
|
- `query_budget` in `query`
|
|
- `requester_date_format` in `query`
|
|
- `search_mode` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `to_date` in `query`
|
|
- `transaction_ids` in `query`
|
|
- `user_filter` in `query`
|
|
- `user_id` in `query`
|
|
- `user_name` in `query`
|
|
|
|
### envelopes_post_envelopes
|
|
|
|
- Operation ID: `envelopes_post_envelopes`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes`
|
|
- Mode: WRITE
|
|
- Summary: Creates an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `cdse_mode` in `query`
|
|
- `change_routing_order` in `query`
|
|
- `completed_documents_only` in `query`
|
|
- `merge_roles_on_draft` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelopes_get_envelope
|
|
|
|
- Operation ID: `envelopes_get_envelope`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}`
|
|
- Mode: READ
|
|
- Summary: Gets the status of a single envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `advanced_update` in `query`
|
|
- `include` in `query`
|
|
- `include_anchor_tab_locations` in `query`
|
|
- `user_id` in `query`
|
|
|
|
### envelopes_put_envelope
|
|
|
|
- Operation ID: `envelopes_put_envelope`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}`
|
|
- Mode: WRITE
|
|
- Summary: Send, void, or modify a draft envelope. Purge documents from a completed envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `advanced_update` in `query`
|
|
- `recycle_on_void` in `query`
|
|
- `resend_envelope` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### attachments_get_attachments
|
|
|
|
- Operation ID: `attachments_get_attachments`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
|
- Mode: READ
|
|
- Summary: Returns a list of envelope attachments associated with a specified envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### attachments_put_attachments
|
|
|
|
- Operation ID: `attachments_put_attachments`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
|
- Mode: WRITE
|
|
- Summary: Adds one or more envelope attachments to a draft or in-process envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### attachments_delete_attachments
|
|
|
|
- Operation ID: `attachments_delete_attachments`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments`
|
|
- Mode: WRITE
|
|
- Summary: Deletes one or more envelope attachments from a draft envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### attachments_get_attachment
|
|
|
|
- Operation ID: `attachments_get_attachment`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}`
|
|
- Mode: READ
|
|
- Summary: Retrieves an envelope attachment from an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `attachmentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### attachments_put_attachment
|
|
|
|
- Operation ID: `attachments_put_attachment`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates an envelope attachment in a draft or in-process envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `attachmentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### audit_events_get_audit_events
|
|
|
|
- Operation ID: `audit_events_get_audit_events`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events`
|
|
- Mode: READ
|
|
- Summary: Gets the envelope audit events for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `locale` in `query`
|
|
|
|
### comments_get_comments_transcript
|
|
|
|
- Operation ID: `comments_get_comments_transcript`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript`
|
|
- Mode: READ
|
|
- Summary: Gets a PDF transcript of all of the comments in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `encoding` in `query`
|
|
|
|
### custom_fields_get_custom_fields
|
|
|
|
- Operation ID: `custom_fields_get_custom_fields`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
|
- Mode: READ
|
|
- Summary: Gets the custom field information for the specified envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### custom_fields_put_custom_fields
|
|
|
|
- Operation ID: `custom_fields_put_custom_fields`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
|
- Mode: WRITE
|
|
- Summary: Updates envelope custom fields in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### custom_fields_post_custom_fields
|
|
|
|
- Operation ID: `custom_fields_post_custom_fields`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
|
- Mode: WRITE
|
|
- Summary: Creates envelope custom fields for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### custom_fields_delete_custom_fields
|
|
|
|
- Operation ID: `custom_fields_delete_custom_fields`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields`
|
|
- Mode: WRITE
|
|
- Summary: Deletes envelope custom fields for draft and in-process envelopes.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### doc_gen_form_fields_get_envelope_doc_gen_form_fields
|
|
|
|
- Operation ID: `doc_gen_form_fields_get_envelope_doc_gen_form_fields`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields`
|
|
- Mode: READ
|
|
- Summary: Returns sender fields for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### doc_gen_form_fields_put_envelope_doc_gen_form_fields
|
|
|
|
- Operation ID: `doc_gen_form_fields_put_envelope_doc_gen_form_fields`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields`
|
|
- Mode: WRITE
|
|
- Summary: Updates sender fields for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `update_docgen_formfields_only` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### documents_get_documents
|
|
|
|
- Operation ID: `documents_get_documents`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
|
- Mode: READ
|
|
- Summary: Gets a list of documents in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `documents_by_userid` in `query`
|
|
- `include_agreement_type` in `query`
|
|
- `include_docgen_formfields` in `query`
|
|
- `include_is_edited` in `query`
|
|
- `include_metadata` in `query`
|
|
- `include_tabs` in `query`
|
|
- `recipient_id` in `query`
|
|
- `shared_user_id` in `query`
|
|
|
|
### documents_put_documents
|
|
|
|
- Operation ID: `documents_put_documents`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
|
- Mode: WRITE
|
|
- Summary: Adds one or more documents to an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### documents_delete_documents
|
|
|
|
- Operation ID: `documents_delete_documents`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`
|
|
- Mode: WRITE
|
|
- Summary: Deletes documents from a draft envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### documents_get_document
|
|
|
|
- Operation ID: `documents_get_document`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}`
|
|
- Mode: READ
|
|
- Summary: Retrieves a single document or all documents from an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `certificate` in `query`
|
|
- `documents_by_userid` in `query`
|
|
- `encoding` in `query`
|
|
- `encrypt` in `query`
|
|
- `language` in `query`
|
|
- `recipient_id` in `query`
|
|
- `shared_user_id` in `query`
|
|
- `show_changes` in `query`
|
|
- `watermark` in `query`
|
|
|
|
### documents_put_document
|
|
|
|
- Operation ID: `documents_put_document`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}`
|
|
- Mode: WRITE
|
|
- Summary: Adds or replaces a document in an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### document_fields_get_document_fields
|
|
|
|
- Operation ID: `document_fields_get_document_fields`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
|
- Mode: READ
|
|
- Summary: Gets the custom document fields from an existing envelope document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### document_fields_put_document_fields
|
|
|
|
- Operation ID: `document_fields_put_document_fields`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
|
- Mode: WRITE
|
|
- Summary: Updates existing custom document fields in an existing envelope document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### document_fields_post_document_fields
|
|
|
|
- Operation ID: `document_fields_post_document_fields`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
|
- Mode: WRITE
|
|
- Summary: Creates custom document fields in an existing envelope document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### document_fields_delete_document_fields
|
|
|
|
- Operation ID: `document_fields_delete_document_fields`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields`
|
|
- Mode: WRITE
|
|
- Summary: Deletes custom document fields from an existing envelope document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### responsive_html_get_envelope_document_html_definitions
|
|
|
|
- Operation ID: `responsive_html_get_envelope_document_html_definitions`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions`
|
|
- Mode: READ
|
|
- Summary: Retrieves the HTML definition used to generate a dynamically sized responsive document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### pages_get_page_images
|
|
|
|
- Operation ID: `pages_get_page_images`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages`
|
|
- Mode: READ
|
|
- Summary: Returns document page images based on input.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `count` in `query`
|
|
- `dpi` in `query`
|
|
- `max_height` in `query`
|
|
- `max_width` in `query`
|
|
- `nocache` in `query`
|
|
- `show_changes` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### pages_delete_page
|
|
|
|
- Operation ID: `pages_delete_page`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a page from a document in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `pageNumber` in `path` required
|
|
|
|
### pages_get_page_image
|
|
|
|
- Operation ID: `pages_get_page_image`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
|
- Mode: READ
|
|
- Summary: Gets a page image from an envelope for display.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `pageNumber` in `path` required
|
|
- `dpi` in `query`
|
|
- `max_height` in `query`
|
|
- `max_width` in `query`
|
|
- `show_changes` in `query`
|
|
|
|
### pages_put_page_image
|
|
|
|
- Operation ID: `pages_put_page_image`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image`
|
|
- Mode: WRITE
|
|
- Summary: Rotates page image from an envelope for display.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `pageNumber` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### tabs_get_page_tabs
|
|
|
|
- Operation ID: `tabs_get_page_tabs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs`
|
|
- Mode: READ
|
|
- Summary: Returns tabs on the specified page.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `pageNumber` in `path` required
|
|
|
|
### responsive_html_post_document_responsive_html_preview
|
|
|
|
- Operation ID: `responsive_html_post_document_responsive_html_preview`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview`
|
|
- Mode: WRITE
|
|
- Summary: Creates a preview of the responsive version of a document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### tabs_get_document_tabs
|
|
|
|
- Operation ID: `tabs_get_document_tabs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
|
- Mode: READ
|
|
- Summary: Returns the tabs on a document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `include_metadata` in `query`
|
|
- `page_numbers` in `query`
|
|
|
|
### tabs_put_document_tabs
|
|
|
|
- Operation ID: `tabs_put_document_tabs`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Updates the tabs for document.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### tabs_post_document_tabs
|
|
|
|
- Operation ID: `tabs_post_document_tabs`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Adds tabs to a document in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### tabs_delete_document_tabs
|
|
|
|
- Operation ID: `tabs_delete_document_tabs`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Deletes tabs from a document in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### templates_get_document_templates
|
|
|
|
- Operation ID: `templates_get_document_templates`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates`
|
|
- Mode: READ
|
|
- Summary: Gets the templates associated with a document in an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `include` in `query`
|
|
|
|
### templates_post_document_templates
|
|
|
|
- Operation ID: `templates_post_document_templates`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates`
|
|
- Mode: WRITE
|
|
- Summary: Adds templates to a document in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `preserve_template_recipient` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### templates_delete_document_templates
|
|
|
|
- Operation ID: `templates_delete_document_templates`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a template from a document in an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `documentId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `templateId` in `path` required
|
|
|
|
### email_settings_get_email_settings
|
|
|
|
- Operation ID: `email_settings_get_email_settings`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
|
- Mode: READ
|
|
- Summary: Gets the email setting overrides for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### email_settings_put_email_settings
|
|
|
|
- Operation ID: `email_settings_put_email_settings`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
|
- Mode: WRITE
|
|
- Summary: Updates the email setting overrides for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### email_settings_post_email_settings
|
|
|
|
- Operation ID: `email_settings_post_email_settings`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
|
- Mode: WRITE
|
|
- Summary: Adds email setting overrides to an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### email_settings_delete_email_settings
|
|
|
|
- Operation ID: `email_settings_delete_email_settings`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the email setting overrides for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### form_data_get_form_data
|
|
|
|
- Operation ID: `form_data_get_form_data`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data`
|
|
- Mode: READ
|
|
- Summary: Returns envelope tab data for an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### responsive_html_get_envelope_html_definitions
|
|
|
|
- Operation ID: `responsive_html_get_envelope_html_definitions`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions`
|
|
- Mode: READ
|
|
- Summary: Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### lock_get_envelope_lock
|
|
|
|
- Operation ID: `lock_get_envelope_lock`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
|
- Mode: READ
|
|
- Summary: Gets envelope lock information.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### lock_put_envelope_lock
|
|
|
|
- Operation ID: `lock_put_envelope_lock`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Updates an envelope lock.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### lock_post_envelope_lock
|
|
|
|
- Operation ID: `lock_post_envelope_lock`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Locks an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### lock_delete_envelope_lock
|
|
|
|
- Operation ID: `lock_delete_envelope_lock`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock`
|
|
- Mode: WRITE
|
|
- Summary: Deletes an envelope lock.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### notification_get_envelopes_envelope_id_notification
|
|
|
|
- Operation ID: `notification_get_envelopes_envelope_id_notification`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification`
|
|
- Mode: READ
|
|
- Summary: Gets envelope notification information.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### notification_put_envelopes_envelope_id_notification
|
|
|
|
- Operation ID: `notification_put_envelopes_envelope_id_notification`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification`
|
|
- Mode: WRITE
|
|
- Summary: Sets envelope notifications for an existing envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_get_recipients
|
|
|
|
- Operation ID: `recipients_get_recipients`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
|
- Mode: READ
|
|
- Summary: Gets the status of recipients for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `include_anchor_tab_locations` in `query`
|
|
- `include_extended` in `query`
|
|
- `include_metadata` in `query`
|
|
- `include_tabs` in `query`
|
|
|
|
### recipients_put_recipients
|
|
|
|
- Operation ID: `recipients_put_recipients`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
|
- Mode: WRITE
|
|
- Summary: Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `combine_same_order_recipients` in `query`
|
|
- `offline_signing` in `query`
|
|
- `resend_envelope` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_post_recipients
|
|
|
|
- Operation ID: `recipients_post_recipients`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
|
- Mode: WRITE
|
|
- Summary: Adds one or more recipients to an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `resend_envelope` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_delete_recipients
|
|
|
|
- Operation ID: `recipients_delete_recipients`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients`
|
|
- Mode: WRITE
|
|
- Summary: Deletes recipients from an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_delete_recipient
|
|
|
|
- Operation ID: `recipients_delete_recipient`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a recipient from an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id
|
|
|
|
- Operation ID: `consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure`
|
|
- Mode: READ
|
|
- Summary: Gets the default Electronic Record and Signature Disclosure for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `langCode` in `query`
|
|
|
|
### consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code
|
|
|
|
- Operation ID: `consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}`
|
|
- Mode: READ
|
|
- Summary: Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `langCode` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `langCode` in `query`
|
|
|
|
### recipients_get_recipient_document_visibility
|
|
|
|
- Operation ID: `recipients_get_recipient_document_visibility`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility`
|
|
- Mode: READ
|
|
- Summary: Returns document visibility for a recipient
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### recipients_put_recipient_document_visibility
|
|
|
|
- Operation ID: `recipients_put_recipient_document_visibility`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility`
|
|
- Mode: WRITE
|
|
- Summary: Updates document visibility for a recipient
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_post_recipient_proof_file_resource_token
|
|
|
|
- Operation ID: `recipients_post_recipient_proof_file_resource_token`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token`
|
|
- Mode: WRITE
|
|
- Summary: Creates a resource token for a sender to request ID Evidence data.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `token_scopes` in `query`
|
|
|
|
### recipients_get_recipient_initials_image
|
|
|
|
- Operation ID: `recipients_get_recipient_initials_image`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image`
|
|
- Mode: READ
|
|
- Summary: Gets the initials image for a user.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `include_chrome` in `query`
|
|
|
|
### recipients_put_recipient_initials_image
|
|
|
|
- Operation ID: `recipients_put_recipient_initials_image`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image`
|
|
- Mode: WRITE
|
|
- Summary: Sets the initials image for an accountless signer.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### recipients_get_recipient_signature
|
|
|
|
- Operation ID: `recipients_get_recipient_signature`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature`
|
|
- Mode: READ
|
|
- Summary: Gets signature information for a signer or sign-in-person recipient.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### recipients_get_recipient_signature_image
|
|
|
|
- Operation ID: `recipients_get_recipient_signature_image`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image`
|
|
- Mode: READ
|
|
- Summary: Retrieve signature image information for a signer/sign-in-person recipient.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `include_chrome` in `query`
|
|
|
|
### recipients_put_recipient_signature_image
|
|
|
|
- Operation ID: `recipients_put_recipient_signature_image`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image`
|
|
- Mode: WRITE
|
|
- Summary: Sets the signature image for an accountless signer.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### recipients_get_recipient_tabs
|
|
|
|
- Operation ID: `recipients_get_recipient_tabs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
|
- Mode: READ
|
|
- Summary: Gets the tabs information for a signer or sign-in-person recipient in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- `include_anchor_tab_locations` in `query`
|
|
- `include_metadata` in `query`
|
|
|
|
### recipients_put_recipient_tabs
|
|
|
|
- Operation ID: `recipients_put_recipient_tabs`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Updates the tabs for a recipient.
|
|
|
|
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_post_recipient_tabs
|
|
|
|
- Operation ID: `recipients_post_recipient_tabs`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Adds tabs for a recipient.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### recipients_delete_recipient_tabs
|
|
|
|
- Operation ID: `recipients_delete_recipient_tabs`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the tabs associated with a recipient.
|
|
|
|
**Note:** It is an error to delete a tab that has the
|
|
`templateLocked` property set to true.
|
|
This property corresponds to the **Restrict changes** option in the web app.
|
|
|
|
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_recipient_manual_review_view
|
|
|
|
- Operation ID: `views_post_recipient_manual_review_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review`
|
|
- Mode: WRITE
|
|
- Summary: Create the link to the page for manually reviewing IDs.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `recipientId` in `path` required
|
|
|
|
### recipients_put_recipients_document_visibility
|
|
|
|
- Operation ID: `recipients_put_recipients_document_visibility`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility`
|
|
- Mode: WRITE
|
|
- Summary: Updates document visibility for recipients
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### responsive_html_post_responsive_html_preview
|
|
|
|
- Operation ID: `responsive_html_post_responsive_html_preview`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview`
|
|
- Mode: WRITE
|
|
- Summary: Creates a preview of the responsive versions of all of the documents in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelopes_shares_get_envelopes_shares
|
|
|
|
- Operation ID: `envelopes_shares_get_envelopes_shares`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
|
- Mode: READ
|
|
- Summary: EnvelopesShares_GetEnvelopesShares
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### envelopes_shares_put_envelopes_shares
|
|
|
|
- Operation ID: `envelopes_shares_put_envelopes_shares`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
|
- Mode: WRITE
|
|
- Summary: EnvelopesShares_PutEnvelopesShares
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelopes_shares_post_envelopes_shares
|
|
|
|
- Operation ID: `envelopes_shares_post_envelopes_shares`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
|
- Mode: WRITE
|
|
- Summary: EnvelopesShares_PostEnvelopesShares
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelopes_shares_delete_envelopes_shares
|
|
|
|
- Operation ID: `envelopes_shares_delete_envelopes_shares`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares`
|
|
- Mode: WRITE
|
|
- Summary: EnvelopesShares_DeleteEnvelopesShares
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|