Files
a2a-platform 81e94a55c6 deploy
2026-06-27 01:02:44 +00:00

30 KiB

name, description
name description
accounts-4-routes Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 4 route group.

accounts 4 API Routes

Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 4 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_password_rules_get_account_password_rules

  • Operation ID: account_password_rules_get_account_password_rules
  • Route: GET /v2.1/accounts/{accountId}/settings/password_rules
  • Mode: READ
  • Summary: Gets the password rules for an account.
  • Parameters:
    • accountId in path required

account_password_rules_put_account_password_rules

  • Operation ID: account_password_rules_put_account_password_rules
  • Route: PUT /v2.1/accounts/{accountId}/settings/password_rules
  • Mode: WRITE
  • Summary: Updates the password rules for an account.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

tab_settings_get_tab_settings

  • Operation ID: tab_settings_get_tab_settings
  • Route: GET /v2.1/accounts/{accountId}/settings/tabs
  • Mode: READ
  • Summary: Returns tab settings list for specified account
  • Parameters:
    • accountId in path required

tab_settings_put_settings

  • Operation ID: tab_settings_put_settings
  • Route: PUT /v2.1/accounts/{accountId}/settings/tabs
  • Mode: WRITE
  • Summary: Modifies tab settings for specified account
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

shared_access_get_shared_access

  • Operation ID: shared_access_get_shared_access
  • Route: GET /v2.1/accounts/{accountId}/shared_access
  • Mode: READ
  • Summary: Reserved: Gets the shared item status for one or more users.
  • Parameters:
    • accountId in path required
    • count in query
    • envelopes_not_shared_user_status in query
    • folder_ids in query
    • item_type in query
    • search_text in query
    • shared in query
    • start_position in query
    • user_ids in query

shared_access_put_shared_access

  • Operation ID: shared_access_put_shared_access
  • Route: PUT /v2.1/accounts/{accountId}/shared_access
  • Mode: WRITE
  • Summary: Reserved: Sets the shared access information for users.
  • Parameters:
    • accountId in path required
    • item_type in query
    • preserve_existing_shared_access in query
    • user_ids in query
  • Body: JSON request body accepted.

account_signature_providers_get_signature_providers

  • Operation ID: account_signature_providers_get_signature_providers
  • Route: GET /v2.1/accounts/{accountId}/signatureProviders
  • Mode: READ
  • Summary: Gets the available signature providers for an account.
  • Parameters:
    • accountId in path required

account_signatures_get_account_signatures

  • Operation ID: account_signatures_get_account_signatures
  • Route: GET /v2.1/accounts/{accountId}/signatures
  • Mode: READ
  • Summary: Returns a list of stamps available in the account.
  • Parameters:
    • accountId in path required
    • stamp_format in query
    • stamp_name in query
    • stamp_type in query

account_signatures_put_account_signature

  • Operation ID: account_signatures_put_account_signature
  • Route: PUT /v2.1/accounts/{accountId}/signatures
  • Mode: WRITE
  • Summary: Updates an account stamp.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

account_signatures_post_account_signatures

  • Operation ID: account_signatures_post_account_signatures
  • Route: POST /v2.1/accounts/{accountId}/signatures
  • Mode: WRITE
  • Summary: Adds or updates one or more account stamps.
  • Parameters:
    • accountId in path required
    • decode_only in query
  • Body: JSON request body accepted.

account_signatures_get_account_signature

  • Operation ID: account_signatures_get_account_signature
  • Route: GET /v2.1/accounts/{accountId}/signatures/{signatureId}
  • Mode: READ
  • Summary: Returns information about the specified stamp.
  • Parameters:
    • accountId in path required
    • signatureId in path required

account_signatures_put_account_signature_by_id

  • Operation ID: account_signatures_put_account_signature_by_id
  • Route: PUT /v2.1/accounts/{accountId}/signatures/{signatureId}
  • Mode: WRITE
  • Summary: Updates an account stamp by ID.
  • Parameters:
    • accountId in path required
    • signatureId in path required
    • close_existing_signature in query
  • Body: JSON request body accepted.

account_signatures_delete_account_signature

  • Operation ID: account_signatures_delete_account_signature
  • Route: DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}
  • Mode: WRITE
  • Summary: Deletes an account stamp.
  • Parameters:
    • accountId in path required
    • signatureId in path required

account_signatures_get_account_signature_image

  • Operation ID: account_signatures_get_account_signature_image
  • Route: GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
  • Mode: READ
  • Summary: Returns the image for an account stamp.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required
    • include_chrome in query

account_signatures_put_account_signature_image

  • Operation ID: account_signatures_put_account_signature_image
  • Route: PUT /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
  • Mode: WRITE
  • Summary: Sets a signature image, initials, or stamp.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required
    • transparent_png in query

account_signatures_delete_account_signature_image

  • Operation ID: account_signatures_delete_account_signature_image
  • Route: DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}
  • Mode: WRITE
  • Summary: Deletes the image for a stamp.
  • Parameters:
    • accountId in path required
    • imageType in path required
    • signatureId in path required

signing_groups_get_signing_groups

  • Operation ID: signing_groups_get_signing_groups
  • Route: GET /v2.1/accounts/{accountId}/signing_groups
  • Mode: READ
  • Summary: Gets a list of the Signing Groups in an account.
  • Parameters:
    • accountId in path required
    • group_type in query
    • include_users in query

signing_groups_put_signing_groups

  • Operation ID: signing_groups_put_signing_groups
  • Route: PUT /v2.1/accounts/{accountId}/signing_groups
  • Mode: WRITE
  • Summary: Updates signing group names.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

signing_groups_post_signing_groups

  • Operation ID: signing_groups_post_signing_groups
  • Route: POST /v2.1/accounts/{accountId}/signing_groups
  • Mode: WRITE
  • Summary: Creates a signing group.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

signing_groups_delete_signing_groups

  • Operation ID: signing_groups_delete_signing_groups
  • Route: DELETE /v2.1/accounts/{accountId}/signing_groups
  • Mode: WRITE
  • Summary: Deletes one or more signing groups.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

signing_groups_get_signing_group

  • Operation ID: signing_groups_get_signing_group
  • Route: GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
  • Mode: READ
  • Summary: Gets information about a signing group.
  • Parameters:
    • accountId in path required
    • signingGroupId in path required

signing_groups_put_signing_group

  • Operation ID: signing_groups_put_signing_group
  • Route: PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}
  • Mode: WRITE
  • Summary: Updates a signing group.
  • Parameters:
    • accountId in path required
    • signingGroupId in path required
  • Body: JSON request body accepted.

signing_groups_get_signing_group_users

  • Operation ID: signing_groups_get_signing_group_users
  • Route: GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
  • Mode: READ
  • Summary: Gets a list of members in a Signing Group.
  • Parameters:
    • accountId in path required
    • signingGroupId in path required

signing_groups_put_signing_group_users

  • Operation ID: signing_groups_put_signing_group_users
  • Route: PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
  • Mode: WRITE
  • Summary: Adds members to a signing group.
  • Parameters:
    • accountId in path required
    • signingGroupId in path required
  • Body: JSON request body accepted.

signing_groups_delete_signing_group_users

  • Operation ID: signing_groups_delete_signing_group_users
  • Route: DELETE /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users
  • Mode: WRITE
  • Summary: Deletes one or more members from a signing group.
  • Parameters:
    • accountId in path required
    • signingGroupId in path required
  • Body: JSON request body accepted.

supported_languages_get_supported_languages

  • Operation ID: supported_languages_get_supported_languages
  • Route: GET /v2.1/accounts/{accountId}/supported_languages
  • Mode: READ
  • Summary: Gets the supported languages for envelope recipients.
  • Parameters:
    • accountId in path required

tabs_get_tab_definitions

  • Operation ID: tabs_get_tab_definitions
  • Route: GET /v2.1/accounts/{accountId}/tab_definitions
  • Mode: READ
  • Summary: Gets a list of all account tabs.
  • Parameters:
    • accountId in path required
    • custom_tab_only in query

tabs_post_tab_definitions

  • Operation ID: tabs_post_tab_definitions
  • Route: POST /v2.1/accounts/{accountId}/tab_definitions
  • Mode: WRITE
  • Summary: Creates a custom tab.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

tab_get_custom_tab

  • Operation ID: tab_get_custom_tab
  • Route: GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}
  • Mode: READ
  • Summary: Gets custom tab information.
  • Parameters:
    • accountId in path required
    • customTabId in path required

tab_put_custom_tab

  • Operation ID: tab_put_custom_tab

  • Route: PUT /v2.1/accounts/{accountId}/tab_definitions/{customTabId}

  • Mode: WRITE

  • Summary: Updates custom tab information.

  • Parameters:

    • accountId in path required
    • customTabId in path required
  • Body: JSON request body accepted.

tab_delete_custom_tab

  • Operation ID: tab_delete_custom_tab
  • Route: DELETE /v2.1/accounts/{accountId}/tab_definitions/{customTabId}
  • Mode: WRITE
  • Summary: Deletes custom tab information.
  • Parameters:
    • accountId in path required
    • customTabId in path required

templates_get_templates

  • Operation ID: templates_get_templates
  • Route: GET /v2.1/accounts/{accountId}/templates
  • Mode: READ
  • Summary: Gets the list of templates.
  • Parameters:
    • accountId in path required
    • count in query
    • created_from_date in query
    • created_to_date in query
    • folder_ids in query
    • folder_types in query
    • from_date in query
    • include in query
    • is_deleted_template_only in query
    • is_download in query
    • link_configuration_id in query
    • modified_from_date in query
    • modified_to_date in query
    • order in query
    • order_by in query
    • search_fields in query
    • search_text in query
    • shared_by_me in query
    • start_position in query
    • template_ids in query
    • to_date in query
    • used_from_date in query
    • used_to_date in query
    • user_filter in query
    • user_id in query

templates_put_templates

  • Operation ID: templates_put_templates
  • Route: PUT /v2.1/accounts/{accountId}/templates
  • Mode: WRITE
  • Summary: Templates_PutTemplates
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

templates_post_templates

  • Operation ID: templates_post_templates
  • Route: POST /v2.1/accounts/{accountId}/templates
  • Mode: WRITE
  • Summary: Creates one or more templates.
  • Parameters:
    • accountId in path required
  • Body: JSON request body accepted.

templates_get_template

  • Operation ID: templates_get_template
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}
  • Mode: READ
  • Summary: Gets a specific template associated with a specified account.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • include in query

templates_put_template

  • Operation ID: templates_put_template
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}
  • Mode: WRITE
  • Summary: Updates an existing template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

templates_put_template_part

  • Operation ID: templates_put_template_part
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
  • Mode: WRITE
  • Summary: Shares a template with a group.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • templatePart in path required
  • Body: JSON request body accepted.

templates_delete_template_part

  • Operation ID: templates_delete_template_part
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}
  • Mode: WRITE
  • Summary: Removes a member group's sharing permissions for a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • templatePart in path required
  • Body: JSON request body accepted.

custom_fields_get_template_custom_fields

  • Operation ID: custom_fields_get_template_custom_fields
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
  • Mode: READ
  • Summary: Gets the custom document fields from a template.
  • Parameters:
    • accountId in path required
    • templateId in path required

custom_fields_put_template_custom_fields

  • Operation ID: custom_fields_put_template_custom_fields
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
  • Mode: WRITE
  • Summary: Updates envelope custom fields in a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

custom_fields_post_template_custom_fields

  • Operation ID: custom_fields_post_template_custom_fields
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
  • Mode: WRITE
  • Summary: Creates custom document fields in an existing template document.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

custom_fields_delete_template_custom_fields

  • Operation ID: custom_fields_delete_template_custom_fields
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields
  • Mode: WRITE
  • Summary: Deletes envelope custom fields in a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

documents_get_template_documents

  • Operation ID: documents_get_template_documents
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents
  • Mode: READ
  • Summary: Gets a list of documents associated with a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • include_agreement_type in query
    • include_is_edited in query
    • include_tabs in query

documents_put_template_documents

  • Operation ID: documents_put_template_documents
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents
  • Mode: WRITE
  • Summary: Adds documents to a template document.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

documents_delete_template_documents

  • Operation ID: documents_delete_template_documents
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents
  • Mode: WRITE
  • Summary: Deletes documents from a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

documents_get_template_document

  • Operation ID: documents_get_template_document
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
  • Mode: READ
  • Summary: Gets PDF documents from a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
    • encrypt in query
    • file_type in query
    • show_changes in query

documents_put_template_document

  • Operation ID: documents_put_template_document
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}
  • Mode: WRITE
  • Summary: Updates a template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
    • is_envelope_definition in query
  • Body: JSON request body accepted.

document_fields_get_template_document_fields

  • Operation ID: document_fields_get_template_document_fields
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
  • Mode: READ
  • Summary: Gets the custom document fields for a an existing template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required

document_fields_put_template_document_fields

  • Operation ID: document_fields_put_template_document_fields
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
  • Mode: WRITE
  • Summary: Updates existing custom document fields in an existing template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

document_fields_post_template_document_fields

  • Operation ID: document_fields_post_template_document_fields
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
  • Mode: WRITE
  • Summary: Creates custom document fields in an existing template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

document_fields_delete_template_document_fields

  • Operation ID: document_fields_delete_template_document_fields
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields
  • Mode: WRITE
  • Summary: Deletes custom document fields from an existing template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

responsive_html_get_template_document_html_definitions

  • Operation ID: responsive_html_get_template_document_html_definitions
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions
  • Mode: READ
  • Summary: Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required

pages_get_template_page_images

  • Operation ID: pages_get_template_page_images
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages
  • Mode: READ
  • Summary: Returns document page images based on input.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId 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_template_page

  • Operation ID: pages_delete_template_page
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}
  • Mode: WRITE
  • Summary: Deletes a page from a document in an template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • pageNumber in path required
    • templateId in path required
  • Body: JSON request body accepted.

pages_get_template_page_image

  • Operation ID: pages_get_template_page_image
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
  • Mode: READ
  • Summary: Gets a page image from a template for display.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • pageNumber in path required
    • templateId in path required
    • dpi in query
    • max_height in query
    • max_width in query
    • show_changes in query

pages_put_template_page_image

  • Operation ID: pages_put_template_page_image
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image
  • Mode: WRITE
  • Summary: Rotates page image from a template for display.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • pageNumber in path required
    • templateId in path required
  • Body: JSON request body accepted.

tabs_get_template_page_tabs

  • Operation ID: tabs_get_template_page_tabs
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs
  • Mode: READ
  • Summary: Returns tabs on the specified page.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • pageNumber in path required
    • templateId in path required

responsive_html_post_template_document_responsive_html_preview

  • Operation ID: responsive_html_post_template_document_responsive_html_preview
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview
  • Mode: WRITE
  • Summary: Creates a preview of the responsive version of a template document.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

tabs_get_template_document_tabs

  • Operation ID: tabs_get_template_document_tabs
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
  • Mode: READ
  • Summary: Returns tabs on a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
    • page_numbers in query

tabs_put_template_document_tabs

  • Operation ID: tabs_put_template_document_tabs
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
  • Mode: WRITE
  • Summary: Updates the tabs for a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

tabs_post_template_document_tabs

  • Operation ID: tabs_post_template_document_tabs
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
  • Mode: WRITE
  • Summary: Adds tabs to a document in a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

tabs_delete_template_document_tabs

  • Operation ID: tabs_delete_template_document_tabs
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs
  • Mode: WRITE
  • Summary: Deletes tabs from a template.
  • Parameters:
    • accountId in path required
    • documentId in path required
    • templateId in path required
  • Body: JSON request body accepted.

responsive_html_get_template_html_definitions

  • Operation ID: responsive_html_get_template_html_definitions
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions
  • Mode: READ
  • Summary: Gets the Original HTML Definition used to generate the Responsive HTML for the template.
  • Parameters:
    • accountId in path required
    • templateId in path required

lock_get_template_lock

  • Operation ID: lock_get_template_lock
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/lock
  • Mode: READ
  • Summary: Gets template lock information.
  • Parameters:
    • accountId in path required
    • templateId in path required

lock_put_template_lock

  • Operation ID: lock_put_template_lock
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/lock
  • Mode: WRITE
  • Summary: Updates a template lock.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

lock_post_template_lock

  • Operation ID: lock_post_template_lock
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/lock
  • Mode: WRITE
  • Summary: Locks a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

lock_delete_template_lock

  • Operation ID: lock_delete_template_lock
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/lock
  • Mode: WRITE
  • Summary: Deletes a template lock.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

notification_get_templates_template_id_notification

  • Operation ID: notification_get_templates_template_id_notification
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/notification
  • Mode: READ
  • Summary: Gets template notification information.
  • Parameters:
    • accountId in path required
    • templateId in path required

notification_put_templates_template_id_notification

  • Operation ID: notification_put_templates_template_id_notification
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/notification
  • Mode: WRITE
  • Summary: Updates the notification structure for an existing template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_get_template_recipients

  • Operation ID: recipients_get_template_recipients
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients
  • Mode: READ
  • Summary: Gets recipient information from a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • include_anchor_tab_locations in query
    • include_extended in query
    • include_tabs in query

recipients_put_template_recipients

  • Operation ID: recipients_put_template_recipients
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients
  • Mode: WRITE
  • Summary: Updates recipients in a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • resend_envelope in query
  • Body: JSON request body accepted.

recipients_post_template_recipients

  • Operation ID: recipients_post_template_recipients
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients
  • Mode: WRITE
  • Summary: Adds tabs for a recipient.
  • Parameters:
    • accountId in path required
    • templateId in path required
    • resend_envelope in query
  • Body: JSON request body accepted.

recipients_delete_template_recipients

  • Operation ID: recipients_delete_template_recipients
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients
  • Mode: WRITE
  • Summary: Deletes recipients from a template.
  • Parameters:
    • accountId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_delete_template_recipient

  • Operation ID: recipients_delete_template_recipient
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}
  • Mode: WRITE
  • Summary: Deletes the specified recipient file from a template.
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_get_template_recipient_document_visibility

  • Operation ID: recipients_get_template_recipient_document_visibility
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
  • Mode: READ
  • Summary: Returns document visibility for a template recipient
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required

recipients_put_template_recipient_document_visibility

  • Operation ID: recipients_put_template_recipient_document_visibility
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility
  • Mode: WRITE
  • Summary: Updates document visibility for a template recipient
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_get_template_recipient_tabs

  • Operation ID: recipients_get_template_recipient_tabs
  • Route: GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
  • Mode: READ
  • Summary: Gets the tabs information for a signer or sign-in-person recipient in a template.
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
    • include_anchor_tab_locations in query
    • include_metadata in query

recipients_put_template_recipient_tabs

  • Operation ID: recipients_put_template_recipient_tabs
  • Route: PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
  • Mode: WRITE
  • Summary: Updates the tabs for a recipient.
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_post_template_recipient_tabs

  • Operation ID: recipients_post_template_recipient_tabs
  • Route: POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
  • Mode: WRITE
  • Summary: Adds tabs for a recipient.
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
  • Body: JSON request body accepted.

recipients_delete_template_recipient_tabs

  • Operation ID: recipients_delete_template_recipient_tabs
  • Route: DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs
  • Mode: WRITE
  • Summary: Deletes the tabs associated with a recipient in a template.
  • Parameters:
    • accountId in path required
    • recipientId in path required
    • templateId in path required
  • Body: JSON request body accepted.