906 lines
30 KiB
Markdown
906 lines
30 KiB
Markdown
---
|
|
name: accounts-3-routes
|
|
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 3 route group.
|
|
---
|
|
|
|
# accounts 3 API Routes
|
|
|
|
Handle 80 OpenAPI operation(s) under /v2.1/accounts/{accountId} for the accounts 3 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
|
|
|
|
### envelopes_shares_get_envelopes_share
|
|
|
|
- Operation ID: `envelopes_shares_get_envelopes_share`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
|
- Mode: READ
|
|
- Summary: EnvelopesShares_GetEnvelopesShare
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `shareId` in `path` required
|
|
|
|
### envelopes_shares_put_envelopes_share
|
|
|
|
- Operation ID: `envelopes_shares_put_envelopes_share`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
|
- Mode: WRITE
|
|
- Summary: EnvelopesShares_PutEnvelopesShare
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `shareId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelopes_shares_delete_envelopes_share
|
|
|
|
- Operation ID: `envelopes_shares_delete_envelopes_share`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}`
|
|
- Mode: WRITE
|
|
- Summary: EnvelopesShares_DeleteEnvelopesShare
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `shareId` in `path` required
|
|
|
|
### tabs_blob_get_tabs_blob
|
|
|
|
- Operation ID: `tabs_blob_get_tabs_blob`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob`
|
|
- Mode: READ
|
|
- Summary: Reserved for Docusign.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### tabs_blob_put_tabs_blob
|
|
|
|
- Operation ID: `tabs_blob_put_tabs_blob`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob`
|
|
- Mode: WRITE
|
|
- Summary: Reserved for Docusign.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### templates_get_envelope_templates
|
|
|
|
- Operation ID: `templates_get_envelope_templates`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates`
|
|
- Mode: READ
|
|
- Summary: Gets templates used in an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `include` in `query`
|
|
|
|
### templates_post_envelope_templates
|
|
|
|
- Operation ID: `templates_post_envelope_templates`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates`
|
|
- Mode: WRITE
|
|
- Summary: Adds templates to an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `preserve_template_recipient` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_correct_view
|
|
|
|
- Operation ID: `views_post_envelope_correct_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct`
|
|
- Mode: WRITE
|
|
- Summary: Returns a URL to the envelope correction UI. Use after an envelope has been sent.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_delete_envelope_correct_view
|
|
|
|
- Operation ID: `views_delete_envelope_correct_view`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct`
|
|
- Mode: WRITE
|
|
- Summary: Revokes the correction view URL to the Envelope UI.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_edit_view
|
|
|
|
- Operation ID: `views_post_envelope_edit_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit`
|
|
- Mode: WRITE
|
|
- Summary: Returns a URL to the edit view UI. Use before an envelope has been sent.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_recipient_view
|
|
|
|
- Operation ID: `views_post_envelope_recipient_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient`
|
|
- Mode: WRITE
|
|
- Summary: Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_recipient_preview
|
|
|
|
- Operation ID: `views_post_envelope_recipient_preview`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview`
|
|
- Mode: WRITE
|
|
- Summary: Creates an envelope recipient preview.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_sender_view
|
|
|
|
- Operation ID: `views_post_envelope_sender_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender`
|
|
- Mode: WRITE
|
|
- Summary: Returns a URL to the sender view UI. Used before an envelope has been sent.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### views_post_envelope_recipient_shared_view
|
|
|
|
- Operation ID: `views_post_envelope_recipient_shared_view`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared`
|
|
- Mode: WRITE
|
|
- Summary: Returns a URL to the shared recipient view UI for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_definition_v2_get_envelope_workflow_definition
|
|
|
|
- Operation ID: `envelope_workflow_definition_v2_get_envelope_workflow_definition`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
|
- Mode: READ
|
|
- Summary: Returns the workflow definition for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### envelope_workflow_definition_v2_put_envelope_workflow_definition
|
|
|
|
- Operation ID: `envelope_workflow_definition_v2_put_envelope_workflow_definition`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
|
- Mode: WRITE
|
|
- Summary: Updates the workflow definition for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_definition_v2_delete_envelope_workflow_definition
|
|
|
|
- Operation ID: `envelope_workflow_definition_v2_delete_envelope_workflow_definition`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow`
|
|
- Mode: WRITE
|
|
- Summary: Delete the workflow definition for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition
|
|
|
|
- Operation ID: `envelope_workflow_scheduled_sending_get_envelope_scheduled_sending_definition`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
|
- Mode: READ
|
|
- Summary: Returns the scheduled sending rules for an envelope's workflow definition.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition
|
|
|
|
- Operation ID: `envelope_workflow_scheduled_sending_put_envelope_scheduled_sending_definition`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
|
- Mode: WRITE
|
|
- Summary: Updates the scheduled sending rules for an envelope's workflow.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition
|
|
|
|
- Operation ID: `envelope_workflow_scheduled_sending_delete_envelope_scheduled_sending_definition`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the scheduled sending rules for the envelope's workflow.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### envelope_workflow_step_post_envelope_workflow_step_definition
|
|
|
|
- Operation ID: `envelope_workflow_step_post_envelope_workflow_step_definition`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps`
|
|
- Mode: WRITE
|
|
- Summary: Adds a new step to an envelope's workflow.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_step_get_envelope_workflow_step_definition
|
|
|
|
- Operation ID: `envelope_workflow_step_get_envelope_workflow_step_definition`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
|
- Mode: READ
|
|
- Summary: Returns a specified workflow step for a specified template.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
|
|
### envelope_workflow_step_put_envelope_workflow_step_definition
|
|
|
|
- Operation ID: `envelope_workflow_step_put_envelope_workflow_step_definition`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates the specified workflow step for an envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_step_delete_envelope_workflow_step_definition
|
|
|
|
- Operation ID: `envelope_workflow_step_delete_envelope_workflow_step_definition`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a workflow step from an envelope's workflow definition.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
|
|
### envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition
|
|
|
|
- Operation ID: `envelope_workflow_delayed_routing_get_envelope_delayed_routing_definition`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
|
- Mode: READ
|
|
- Summary: Returns the delayed routing rules for an envelope's workflow step definition.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
|
|
### envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition
|
|
|
|
- Operation ID: `envelope_workflow_delayed_routing_put_envelope_delayed_routing_definition`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
|
- Mode: WRITE
|
|
- Summary: Updates the delayed routing rules for an envelope's workflow step definition.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition
|
|
|
|
- Operation ID: `envelope_workflow_delayed_routing_delete_envelope_delayed_routing_definition`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the delayed routing rules for the specified envelope workflow step.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
- `workflowStepId` in `path` required
|
|
|
|
### shared_envelopes_list_get_shared_envelopes
|
|
|
|
- Operation ID: `shared_envelopes_list_get_shared_envelopes`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/shared`
|
|
- Mode: READ
|
|
- Summary: SharedEnvelopesList_GetSharedEnvelopes
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `from_date` in `query`
|
|
- `include` in `query`
|
|
- `order` in `query`
|
|
- `order_by` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### envelopes_put_status
|
|
|
|
- Operation ID: `envelopes_put_status`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/status`
|
|
- Mode: WRITE
|
|
- Summary: Gets envelope statuses for a set of envelopes.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `ac_status` in `query`
|
|
- `block` in `query`
|
|
- `count` in `query`
|
|
- `email` in `query`
|
|
- `envelope_ids` in `query`
|
|
- `from_date` in `query`
|
|
- `from_to_status` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `to_date` in `query`
|
|
- `transaction_ids` in `query`
|
|
- `user_name` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_transfer_rules_get_envelope_transfer_rules
|
|
|
|
- Operation ID: `envelope_transfer_rules_get_envelope_transfer_rules`
|
|
- Route: `GET /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
|
- Mode: READ
|
|
- Summary: Gets envelope transfer rules.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### envelope_transfer_rules_put_envelope_transfer_rules
|
|
|
|
- Operation ID: `envelope_transfer_rules_put_envelope_transfer_rules`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
|
- Mode: WRITE
|
|
- Summary: Changes the status of multiple envelope transfer rules.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_transfer_rules_post_envelope_transfer_rules
|
|
|
|
- Operation ID: `envelope_transfer_rules_post_envelope_transfer_rules`
|
|
- Route: `POST /v2.1/accounts/{accountId}/envelopes/transfer_rules`
|
|
- Mode: WRITE
|
|
- Summary: Creates an envelope transfer rule.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_transfer_rules_put_envelope_transfer_rule
|
|
|
|
- Operation ID: `envelope_transfer_rules_put_envelope_transfer_rule`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}`
|
|
- Mode: WRITE
|
|
- Summary: Changes the status of an envelope transfer rule.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeTransferRuleId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### envelope_transfer_rules_delete_envelope_transfer_rules
|
|
|
|
- Operation ID: `envelope_transfer_rules_delete_envelope_transfer_rules`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes an envelope transfer rule.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeTransferRuleId` in `path` required
|
|
|
|
### favorite_templates_get_favorite_templates
|
|
|
|
- Operation ID: `favorite_templates_get_favorite_templates`
|
|
- Route: `GET /v2.1/accounts/{accountId}/favorite_templates`
|
|
- Mode: READ
|
|
- Summary: Retrieves the list of favorite templates for the account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### favorite_templates_put_favorite_template
|
|
|
|
- Operation ID: `favorite_templates_put_favorite_template`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/favorite_templates`
|
|
- Mode: WRITE
|
|
- Summary: Set one or more templates as account favorites.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### favorite_templates_un_favorite_template
|
|
|
|
- Operation ID: `favorite_templates_un_favorite_template`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/favorite_templates`
|
|
- Mode: WRITE
|
|
- Summary: Remove one or more templates from the account favorites.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### folders_get_folders
|
|
|
|
- Operation ID: `folders_get_folders`
|
|
- Route: `GET /v2.1/accounts/{accountId}/folders`
|
|
- Mode: READ
|
|
- Summary: Returns a list of the account's folders.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `include` in `query`
|
|
- `include_items` in `query`
|
|
- `start_position` in `query`
|
|
- `sub_folder_depth` in `query`
|
|
- `template` in `query`
|
|
- `user_filter` in `query`
|
|
|
|
### folders_get_folder_items
|
|
|
|
- Operation ID: `folders_get_folder_items`
|
|
- Route: `GET /v2.1/accounts/{accountId}/folders/{folderId}`
|
|
- Mode: READ
|
|
- Summary: Gets information about items in a specified folder.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `folderId` in `path` required
|
|
- `from_date` in `query`
|
|
- `include_items` in `query`
|
|
- `owner_email` in `query`
|
|
- `owner_name` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### folders_put_folder_by_id
|
|
|
|
- Operation ID: `folders_put_folder_by_id`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/folders/{folderId}`
|
|
- Mode: WRITE
|
|
- Summary: Moves a set of envelopes from their current folder to another folder.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `folderId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_get_groups
|
|
|
|
- Operation ID: `groups_get_groups`
|
|
- Route: `GET /v2.1/accounts/{accountId}/groups`
|
|
- Mode: READ
|
|
- Summary: Gets information about groups associated with the account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `group_type` in `query`
|
|
- `include_usercount` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### groups_put_groups
|
|
|
|
- Operation ID: `groups_put_groups`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/groups`
|
|
- Mode: WRITE
|
|
- Summary: Updates the group information for a group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_post_groups
|
|
|
|
- Operation ID: `groups_post_groups`
|
|
- Route: `POST /v2.1/accounts/{accountId}/groups`
|
|
- Mode: WRITE
|
|
- Summary: Creates one or more groups for the account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_delete_groups
|
|
|
|
- Operation ID: `groups_delete_groups`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/groups`
|
|
- Mode: WRITE
|
|
- Summary: Deletes an existing user group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brands_get_group_brands
|
|
|
|
- Operation ID: `brands_get_group_brands`
|
|
- Route: `GET /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
|
- Mode: READ
|
|
- Summary: Gets the brand information for a group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
|
|
### brands_put_group_brands
|
|
|
|
- Operation ID: `brands_put_group_brands`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
|
- Mode: WRITE
|
|
- Summary: Adds an existing brand to a group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brands_delete_group_brands
|
|
|
|
- Operation ID: `brands_delete_group_brands`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/groups/{groupId}/brands`
|
|
- Mode: WRITE
|
|
- Summary: Deletes brand information from a group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_get_group_users
|
|
|
|
- Operation ID: `groups_get_group_users`
|
|
- Route: `GET /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
|
- Mode: READ
|
|
- Summary: Gets a list of users in a group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
- `count` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### groups_put_group_users
|
|
|
|
- Operation ID: `groups_put_group_users`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
|
- Mode: WRITE
|
|
- Summary: Adds one or more users to an existing group.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### groups_delete_group_users
|
|
|
|
- Operation ID: `groups_delete_group_users`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/groups/{groupId}/users`
|
|
- Mode: WRITE
|
|
- Summary: Deletes one or more users from a group
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `groupId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### account_identity_verification_get_account_identity_verification
|
|
|
|
- Operation ID: `account_identity_verification_get_account_identity_verification`
|
|
- Route: `GET /v2.1/accounts/{accountId}/identity_verification`
|
|
- Mode: READ
|
|
- Summary: Retrieves the Identity Verification workflows available to an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `identity_verification_workflow_status` in `query`
|
|
|
|
### payment_gateway_accounts_get_all_payment_gateway_accounts
|
|
|
|
- Operation ID: `payment_gateway_accounts_get_all_payment_gateway_accounts`
|
|
- Route: `GET /v2.1/accounts/{accountId}/payment_gateway_accounts`
|
|
- Mode: READ
|
|
- Summary: List payment gateway accounts
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### permission_profiles_get_permission_profiles
|
|
|
|
- Operation ID: `permission_profiles_get_permission_profiles`
|
|
- Route: `GET /v2.1/accounts/{accountId}/permission_profiles`
|
|
- Mode: READ
|
|
- Summary: Gets a list of permission profiles.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `include` in `query`
|
|
|
|
### permission_profiles_post_permission_profiles
|
|
|
|
- Operation ID: `permission_profiles_post_permission_profiles`
|
|
- Route: `POST /v2.1/accounts/{accountId}/permission_profiles`
|
|
- Mode: WRITE
|
|
- Summary: Creates a new permission profile for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `include` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### permission_profiles_get_permission_profile
|
|
|
|
- Operation ID: `permission_profiles_get_permission_profile`
|
|
- Route: `GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
|
- Mode: READ
|
|
- Summary: Returns a permission profile for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `permissionProfileId` in `path` required
|
|
- `include` in `query`
|
|
|
|
### permission_profiles_put_permission_profiles
|
|
|
|
- Operation ID: `permission_profiles_put_permission_profiles`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates a permission profile.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `permissionProfileId` in `path` required
|
|
- `include` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### permission_profiles_delete_permission_profiles
|
|
|
|
- Operation ID: `permission_profiles_delete_permission_profiles`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a permission profile from an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `permissionProfileId` in `path` required
|
|
- `move_users_to` in `query`
|
|
|
|
### power_forms_get_power_forms_list
|
|
|
|
- Operation ID: `power_forms_get_power_forms_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/powerforms`
|
|
- Mode: READ
|
|
- Summary: Returns a list of PowerForms.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `from_date` in `query`
|
|
- `order` in `query`
|
|
- `order_by` in `query`
|
|
- `search_fields` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### power_forms_post_power_form
|
|
|
|
- Operation ID: `power_forms_post_power_form`
|
|
- Route: `POST /v2.1/accounts/{accountId}/powerforms`
|
|
- Mode: WRITE
|
|
- Summary: Creates a new PowerForm
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### power_forms_delete_power_forms_list
|
|
|
|
- Operation ID: `power_forms_delete_power_forms_list`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/powerforms`
|
|
- Mode: WRITE
|
|
- Summary: Deletes one or more PowerForms.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### power_forms_get_power_form
|
|
|
|
- Operation ID: `power_forms_get_power_form`
|
|
- Route: `GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
|
- Mode: READ
|
|
- Summary: Returns a single PowerForm.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `powerFormId` in `path` required
|
|
|
|
### power_forms_put_power_form
|
|
|
|
- Operation ID: `power_forms_put_power_form`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates an existing PowerForm.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `powerFormId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### power_forms_delete_power_form
|
|
|
|
- Operation ID: `power_forms_delete_power_form`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/powerforms/{powerFormId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a PowerForm.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `powerFormId` in `path` required
|
|
|
|
### power_forms_get_power_form_form_data
|
|
|
|
- Operation ID: `power_forms_get_power_form_form_data`
|
|
- Route: `GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data`
|
|
- Mode: READ
|
|
- Summary: Returns the data that users entered in a PowerForm.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `powerFormId` in `path` required
|
|
- `data_layout` in `query`
|
|
- `from_date` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### power_forms_get_power_forms_senders
|
|
|
|
- Operation ID: `power_forms_get_power_forms_senders`
|
|
- Route: `GET /v2.1/accounts/{accountId}/powerforms/senders`
|
|
- Mode: READ
|
|
- Summary: Gets PowerForm senders.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `start_position` in `query`
|
|
|
|
### account_signature_providers_get_seal_providers
|
|
|
|
- Operation ID: `account_signature_providers_get_seal_providers`
|
|
- Route: `GET /v2.1/accounts/{accountId}/seals`
|
|
- Mode: READ
|
|
- Summary: Returns available seals for specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### search_folders_get_search_folder_contents
|
|
|
|
- Operation ID: `search_folders_get_search_folder_contents`
|
|
- Route: `GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}`
|
|
- Mode: READ
|
|
- Summary: Deprecated. Use Envelopes: listStatusChanges.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `searchFolderId` in `path` required
|
|
- `all` in `query`
|
|
- `count` in `query`
|
|
- `from_date` in `query`
|
|
- `include_recipients` in `query`
|
|
- `order` in `query`
|
|
- `order_by` in `query`
|
|
- `start_position` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### settings_get_settings
|
|
|
|
- Operation ID: `settings_get_settings`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings`
|
|
- Mode: READ
|
|
- Summary: Gets account settings information.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### settings_put_settings
|
|
|
|
- Operation ID: `settings_put_settings`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/settings`
|
|
- Mode: WRITE
|
|
- Summary: Updates the account settings for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bcc_email_archive_get_bcc_email_archive_list
|
|
|
|
- Operation ID: `bcc_email_archive_get_bcc_email_archive_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings/bcc_email_archives`
|
|
- Mode: READ
|
|
- Summary: Gets the BCC email archive configurations for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `count` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### bcc_email_archive_post_bcc_email_archive
|
|
|
|
- Operation ID: `bcc_email_archive_post_bcc_email_archive`
|
|
- Route: `POST /v2.1/accounts/{accountId}/settings/bcc_email_archives`
|
|
- Mode: WRITE
|
|
- Summary: Creates a BCC email archive configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bcc_email_archive_get_bcc_email_archive_history_list
|
|
|
|
- Operation ID: `bcc_email_archive_get_bcc_email_archive_history_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}`
|
|
- Mode: READ
|
|
- Summary: Gets a BCC email archive configuration and its history.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bccEmailArchiveId` in `path` required
|
|
- `count` in `query`
|
|
- `start_position` in `query`
|
|
|
|
### bcc_email_archive_delete_bcc_email_archive
|
|
|
|
- Operation ID: `bcc_email_archive_delete_bcc_email_archive`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a BCC email archive configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bccEmailArchiveId` in `path` required
|
|
|
|
### e_note_configuration_get_e_note_configuration
|
|
|
|
- Operation ID: `e_note_configuration_get_e_note_configuration`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings/enote_configuration`
|
|
- Mode: READ
|
|
- Summary: Returns the configuration information for the eNote eOriginal integration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### e_note_configuration_put_e_note_configuration
|
|
|
|
- Operation ID: `e_note_configuration_put_e_note_configuration`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/settings/enote_configuration`
|
|
- Mode: WRITE
|
|
- Summary: Updates configuration information for the eNote eOriginal integration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### e_note_configuration_delete_e_note_configuration
|
|
|
|
- Operation ID: `e_note_configuration_delete_e_note_configuration`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/settings/enote_configuration`
|
|
- Mode: WRITE
|
|
- Summary: Deletes configuration information for the eNote eOriginal integration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### envelope_purge_configuration_get_envelope_purge_configuration
|
|
|
|
- Operation ID: `envelope_purge_configuration_get_envelope_purge_configuration`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration`
|
|
- Mode: READ
|
|
- Summary: Gets the envelope purge configuration for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### envelope_purge_configuration_put_envelope_purge_configuration
|
|
|
|
- Operation ID: `envelope_purge_configuration_put_envelope_purge_configuration`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration`
|
|
- Mode: WRITE
|
|
- Summary: Sets the envelope purge configuration for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### notification_defaults_get_notification_defaults
|
|
|
|
- Operation ID: `notification_defaults_get_notification_defaults`
|
|
- Route: `GET /v2.1/accounts/{accountId}/settings/notification_defaults`
|
|
- Mode: READ
|
|
- Summary: Gets envelope notification defaults.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### notification_defaults_put_notification_defaults
|
|
|
|
- Operation ID: `notification_defaults_put_notification_defaults`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/settings/notification_defaults`
|
|
- Mode: WRITE
|
|
- Summary: Updates envelope notification default settings.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|