869 lines
26 KiB
Markdown
869 lines
26 KiB
Markdown
---
|
|
name: accounts-1-routes
|
|
description: Handle 80 OpenAPI operation(s) under /v2.1/accounts for the accounts 1 route group.
|
|
---
|
|
|
|
# accounts 1 API Routes
|
|
|
|
Handle 80 OpenAPI operation(s) under /v2.1/accounts for the accounts 1 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
|
|
|
|
### accounts_post_accounts
|
|
|
|
- Operation ID: `accounts_post_accounts`
|
|
- Route: `POST /v2.1/accounts`
|
|
- Mode: WRITE
|
|
- Summary: Creates new accounts.
|
|
- Body: JSON request body accepted.
|
|
|
|
### accounts_get_account
|
|
|
|
- Operation ID: `accounts_get_account`
|
|
- Route: `GET /v2.1/accounts/{accountId}`
|
|
- Mode: READ
|
|
- Summary: Retrieves the account information for the specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `include_account_settings` in `query`
|
|
- `include_trial_eligibility` in `query`
|
|
|
|
### accounts_delete_account
|
|
|
|
- Operation ID: `accounts_delete_account`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `redact_user_data` in `query`
|
|
|
|
### billing_charges_get_account_billing_charges
|
|
|
|
- Operation ID: `billing_charges_get_account_billing_charges`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_charges`
|
|
- Mode: READ
|
|
- Summary: Gets list of recurring and usage charges for the account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `include_charges` in `query`
|
|
|
|
### billing_invoices_get_billing_invoices
|
|
|
|
- Operation ID: `billing_invoices_get_billing_invoices`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices`
|
|
- Mode: READ
|
|
- Summary: Get a List of Billing Invoices
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `from_date` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### billing_invoices_get_billing_invoice
|
|
|
|
- Operation ID: `billing_invoices_get_billing_invoice`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}`
|
|
- Mode: READ
|
|
- Summary: Retrieves a billing invoice.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `invoiceId` in `path` required
|
|
|
|
### billing_invoices_get_billing_invoices_past_due
|
|
|
|
- Operation ID: `billing_invoices_get_billing_invoices_past_due`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_invoices_past_due`
|
|
- Mode: READ
|
|
- Summary: Get a list of past due invoices.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### billing_payments_get_payment_list
|
|
|
|
- Operation ID: `billing_payments_get_payment_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_payments`
|
|
- Mode: READ
|
|
- Summary: Gets payment information for one or more payments.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `from_date` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### billing_payments_post_payment
|
|
|
|
- Operation ID: `billing_payments_post_payment`
|
|
- Route: `POST /v2.1/accounts/{accountId}/billing_payments`
|
|
- Mode: WRITE
|
|
- Summary: Posts a payment to a past due invoice.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### billing_payments_get_payment
|
|
|
|
- Operation ID: `billing_payments_get_payment`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}`
|
|
- Mode: READ
|
|
- Summary: Gets billing payment information for a specific payment.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `paymentId` in `path` required
|
|
|
|
### billing_plan_get_billing_plan
|
|
|
|
- Operation ID: `billing_plan_get_billing_plan`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_plan`
|
|
- Mode: READ
|
|
- Summary: Get Account Billing Plan
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `include_credit_card_information` in `query`
|
|
- `include_downgrade_information` in `query`
|
|
- `include_metadata` in `query`
|
|
- `include_successor_plans` in `query`
|
|
- `include_tax_exempt_id` in `query`
|
|
|
|
### billing_plan_put_billing_plan
|
|
|
|
- Operation ID: `billing_plan_put_billing_plan`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan`
|
|
- Mode: WRITE
|
|
- Summary: Updates an account billing plan.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `preview_billing_plan` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### billing_plan_get_credit_card_info
|
|
|
|
- Operation ID: `billing_plan_get_credit_card_info`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_plan/credit_card`
|
|
- Mode: READ
|
|
- Summary: Get credit card information
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### billing_plan_get_downgrade_request_billing_info
|
|
|
|
- Operation ID: `billing_plan_get_downgrade_request_billing_info`
|
|
- Route: `GET /v2.1/accounts/{accountId}/billing_plan/downgrade`
|
|
- Mode: READ
|
|
- Summary: Returns downgrade plan information for the specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### billing_plan_put_downgrade_account_billing_plan
|
|
|
|
- Operation ID: `billing_plan_put_downgrade_account_billing_plan`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan/downgrade`
|
|
- Mode: WRITE
|
|
- Summary: Queues downgrade billing plan request for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### purchased_envelopes_put_purchased_envelopes
|
|
|
|
- Operation ID: `purchased_envelopes_put_purchased_envelopes`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes`
|
|
- Mode: WRITE
|
|
- Summary: Reserved: Purchase additional envelopes.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brands_get_brands
|
|
|
|
- Operation ID: `brands_get_brands`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands`
|
|
- Mode: READ
|
|
- Summary: Gets a list of brands.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `exclude_distributor_brand` in `query`
|
|
- `include_logos` in `query`
|
|
|
|
### brands_post_brands
|
|
|
|
- Operation ID: `brands_post_brands`
|
|
- Route: `POST /v2.1/accounts/{accountId}/brands`
|
|
- Mode: WRITE
|
|
- Summary: Creates one or more brand profiles for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brands_delete_brands
|
|
|
|
- Operation ID: `brands_delete_brands`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/brands`
|
|
- Mode: WRITE
|
|
- Summary: Deletes one or more brand profiles.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brand_get_brand
|
|
|
|
- Operation ID: `brand_get_brand`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}`
|
|
- Mode: READ
|
|
- Summary: Gets information about a brand.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `include_external_references` in `query`
|
|
- `include_logos` in `query`
|
|
|
|
### brand_put_brand
|
|
|
|
- Operation ID: `brand_put_brand`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates an existing brand.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `replace_brand` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### brand_delete_brand
|
|
|
|
- Operation ID: `brand_delete_brand`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/brands/{brandId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a brand.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
|
|
### brand_export_get_brand_export_file
|
|
|
|
- Operation ID: `brand_export_get_brand_export_file`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/file`
|
|
- Mode: READ
|
|
- Summary: Exports a brand.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
|
|
### brand_logo_get_brand_logo
|
|
|
|
- Operation ID: `brand_logo_get_brand_logo`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
|
- Mode: READ
|
|
- Summary: Gets a brand logo.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `logoType` in `path` required
|
|
|
|
### brand_logo_put_brand_logo
|
|
|
|
- Operation ID: `brand_logo_put_brand_logo`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
|
- Mode: WRITE
|
|
- Summary: Updates a brand logo.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `logoType` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### brand_logo_delete_brand_logo
|
|
|
|
- Operation ID: `brand_logo_delete_brand_logo`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a brand logo.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `logoType` in `path` required
|
|
|
|
### brand_resources_get_brand_resources_list
|
|
|
|
- Operation ID: `brand_resources_get_brand_resources_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/resources`
|
|
- Mode: READ
|
|
- Summary: Returns metadata about the branding resources for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
|
|
### brand_resources_get_brand_resources
|
|
|
|
- Operation ID: `brand_resources_get_brand_resources`
|
|
- Route: `GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}`
|
|
- Mode: READ
|
|
- Summary: Returns a branding resource file.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `resourceContentType` in `path` required
|
|
- `langcode` in `query`
|
|
- `return_master` in `query`
|
|
|
|
### brand_resources_put_brand_resources
|
|
|
|
- Operation ID: `brand_resources_put_brand_resources`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}`
|
|
- Mode: WRITE
|
|
- Summary: Updates a branding resource file.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `brandId` in `path` required
|
|
- `resourceContentType` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_batch_get_bulk_send_batches
|
|
|
|
- Operation ID: `bulk_send_v2_batch_get_bulk_send_batches`
|
|
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch`
|
|
- Mode: READ
|
|
- Summary: Returns a list of bulk send batch summaries.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `batch_ids` in `query`
|
|
- `count` in `query`
|
|
- `from_date` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `to_date` in `query`
|
|
- `user_id` in `query`
|
|
|
|
### bulk_send_v2_batch_get_bulk_send_batch_status
|
|
|
|
- Operation ID: `bulk_send_v2_batch_get_bulk_send_batch_status`
|
|
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}`
|
|
- Mode: READ
|
|
- Summary: Gets the status of a specific bulk send batch.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendBatchId` in `path` required
|
|
|
|
### bulk_send_v2_batch_put_bulk_send_batch_status
|
|
|
|
- Operation ID: `bulk_send_v2_batch_put_bulk_send_batch_status`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates the name of a bulk send batch.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendBatchId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_batch_put_bulk_send_batch_action
|
|
|
|
- Operation ID: `bulk_send_v2_batch_put_bulk_send_batch_action`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}`
|
|
- Mode: WRITE
|
|
- Summary: Applies a bulk action to all envelopes from a specified bulk send.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkAction` in `path` required
|
|
- `bulkSendBatchId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_envelopes_get_bulk_send_batch_envelopes
|
|
|
|
- Operation ID: `bulk_send_v2_envelopes_get_bulk_send_batch_envelopes`
|
|
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes`
|
|
- Mode: READ
|
|
- Summary: Gets envelopes from a specific bulk send batch.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendBatchId` in `path` required
|
|
- `count` in `query`
|
|
- `include` in `query`
|
|
- `order` in `query`
|
|
- `order_by` in `query`
|
|
- `search_text` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
|
|
### bulk_send_v2_crud_get_bulk_send_lists
|
|
|
|
- Operation ID: `bulk_send_v2_crud_get_bulk_send_lists`
|
|
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_lists`
|
|
- Mode: READ
|
|
- Summary: Gets bulk send lists.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### bulk_send_v2_crud_post_bulk_send_list
|
|
|
|
- Operation ID: `bulk_send_v2_crud_post_bulk_send_list`
|
|
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists`
|
|
- Mode: WRITE
|
|
- Summary: Creates a bulk send list.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_crud_get_bulk_send_list
|
|
|
|
- Operation ID: `bulk_send_v2_crud_get_bulk_send_list`
|
|
- Route: `GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
|
- Mode: READ
|
|
- Summary: Gets a specific bulk send list.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendListId` in `path` required
|
|
|
|
### bulk_send_v2_crud_put_bulk_send_list
|
|
|
|
- Operation ID: `bulk_send_v2_crud_put_bulk_send_list`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
|
- Mode: WRITE
|
|
- Summary: Updates a bulk send list.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendListId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_crud_delete_bulk_send_list
|
|
|
|
- Operation ID: `bulk_send_v2_crud_delete_bulk_send_list`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a bulk send list.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendListId` in `path` required
|
|
|
|
### bulk_send_v2_send_post_bulk_send_request
|
|
|
|
- Operation ID: `bulk_send_v2_send_post_bulk_send_request`
|
|
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send`
|
|
- Mode: WRITE
|
|
- Summary: Creates a bulk send request.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendListId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_send_v2_test_post_bulk_send_test_request
|
|
|
|
- Operation ID: `bulk_send_v2_test_post_bulk_send_test_request`
|
|
- Route: `POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test`
|
|
- Mode: WRITE
|
|
- Summary: Creates a bulk send test.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `bulkSendListId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### captive_recipients_delete_captive_recipients_part
|
|
|
|
- Operation ID: `captive_recipients_delete_captive_recipients_part`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/captive_recipients/{recipientPart}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the signature for one or more captive recipient records.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `recipientPart` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### chunked_uploads_post_chunked_uploads
|
|
|
|
- Operation ID: `chunked_uploads_post_chunked_uploads`
|
|
- Route: `POST /v2.1/accounts/{accountId}/chunked_uploads`
|
|
- Mode: WRITE
|
|
- Summary: Initiate a new chunked upload.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### chunked_uploads_get_chunked_upload
|
|
|
|
- Operation ID: `chunked_uploads_get_chunked_upload`
|
|
- Route: `GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
|
- Mode: READ
|
|
- Summary: Retrieves metadata about a chunked upload.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `chunkedUploadId` in `path` required
|
|
- `include` in `query`
|
|
|
|
### chunked_uploads_put_chunked_uploads
|
|
|
|
- Operation ID: `chunked_uploads_put_chunked_uploads`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
|
- Mode: WRITE
|
|
- Summary: Commit a chunked upload.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `chunkedUploadId` in `path` required
|
|
- `action` in `query`
|
|
|
|
### chunked_uploads_delete_chunked_upload
|
|
|
|
- Operation ID: `chunked_uploads_delete_chunked_upload`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a chunked upload.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `chunkedUploadId` in `path` required
|
|
|
|
### chunked_uploads_put_chunked_upload_part
|
|
|
|
- Operation ID: `chunked_uploads_put_chunked_upload_part`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}`
|
|
- Mode: WRITE
|
|
- Summary: Add a chunk to an existing chunked upload.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `chunkedUploadId` in `path` required
|
|
- `chunkedUploadPartSeq` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_get_connect_configs
|
|
|
|
- Operation ID: `connect_get_connect_configs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect`
|
|
- Mode: READ
|
|
- Summary: Get Connect configuration information.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_put_connect_configuration
|
|
|
|
- Operation ID: `connect_put_connect_configuration`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/connect`
|
|
- Mode: WRITE
|
|
- Summary: Updates a specified Connect configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_post_connect_configuration
|
|
|
|
- Operation ID: `connect_post_connect_configuration`
|
|
- Route: `POST /v2.1/accounts/{accountId}/connect`
|
|
- Mode: WRITE
|
|
- Summary: Creates a Connect configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_get_connect_config
|
|
|
|
- Operation ID: `connect_get_connect_config`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}`
|
|
- Mode: READ
|
|
- Summary: Gets the details about a Connect configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `connectId` in `path` required
|
|
|
|
### connect_delete_connect_config
|
|
|
|
- Operation ID: `connect_delete_connect_config`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/{connectId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the specified Connect configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `connectId` in `path` required
|
|
|
|
### connect_get_connect_all_users
|
|
|
|
- Operation ID: `connect_get_connect_all_users`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users`
|
|
- Mode: READ
|
|
- Summary: Returns all users from the configured Connect service.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `connectId` in `path` required
|
|
- `count` in `query`
|
|
- `domain_users_only` in `query`
|
|
- `email_substring` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `user_name_substring` in `query`
|
|
|
|
### connect_get_connect_users
|
|
|
|
- Operation ID: `connect_get_connect_users`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/{connectId}/users`
|
|
- Mode: READ
|
|
- Summary: Returns users from the configured Connect service.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `connectId` in `path` required
|
|
- `count` in `query`
|
|
- `email_substring` in `query`
|
|
- `list_included_users` in `query`
|
|
- `start_position` in `query`
|
|
- `status` in `query`
|
|
- `user_name_substring` in `query`
|
|
|
|
### connect_publish_put_connect_retry_by_envelope
|
|
|
|
- Operation ID: `connect_publish_put_connect_retry_by_envelope`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue`
|
|
- Mode: WRITE
|
|
- Summary: Republishes Connect information for the specified envelope.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `envelopeId` in `path` required
|
|
|
|
### historical_envelope_publish_post_historical_envelope_publish_transaction
|
|
|
|
- Operation ID: `historical_envelope_publish_post_historical_envelope_publish_transaction`
|
|
- Route: `POST /v2.1/accounts/{accountId}/connect/envelopes/publish/historical`
|
|
- Mode: WRITE
|
|
- Summary: Submits a batch of historical envelopes for republish to a webhook.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_publish_put_connect_retry
|
|
|
|
- Operation ID: `connect_publish_put_connect_retry`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/connect/envelopes/retry_queue`
|
|
- Mode: WRITE
|
|
- Summary: Republishes Connect information for multiple envelopes.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_failures_get_connect_logs
|
|
|
|
- Operation ID: `connect_failures_get_connect_logs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/failures`
|
|
- Mode: READ
|
|
- Summary: Gets the Connect failure log information.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `from_date` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### connect_failures_delete_connect_failure_log
|
|
|
|
- Operation ID: `connect_failures_delete_connect_failure_log`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/failures/{failureId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a Connect failure log entry.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `failureId` in `path` required
|
|
|
|
### connect_log_get_connect_logs
|
|
|
|
- Operation ID: `connect_log_get_connect_logs`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/logs`
|
|
- Mode: READ
|
|
- Summary: Gets the Connect log.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `from_date` in `query`
|
|
- `to_date` in `query`
|
|
|
|
### connect_log_delete_connect_logs
|
|
|
|
- Operation ID: `connect_log_delete_connect_logs`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/logs`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a list of Connect log entries.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_log_get_connect_log
|
|
|
|
- Operation ID: `connect_log_get_connect_log`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/logs/{logId}`
|
|
- Mode: READ
|
|
- Summary: Gets a Connect log entry.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `logId` in `path` required
|
|
- `additional_info` in `query`
|
|
|
|
### connect_log_delete_connect_log
|
|
|
|
- Operation ID: `connect_log_delete_connect_log`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/logs/{logId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a specified Connect log entry.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `logId` in `path` required
|
|
|
|
### connect_o_auth_config_get_connect_o_auth_config
|
|
|
|
- Operation ID: `connect_o_auth_config_get_connect_o_auth_config`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/oauth`
|
|
- Mode: READ
|
|
- Summary: Retrieves the Connect OAuth information for the account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_o_auth_config_put_connect_o_auth_config
|
|
|
|
- Operation ID: `connect_o_auth_config_put_connect_o_auth_config`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/connect/oauth`
|
|
- Mode: WRITE
|
|
- Summary: Updates the existing Connect OAuth configuration for the account.
|
|
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_o_auth_config_post_connect_o_auth_config
|
|
|
|
- Operation ID: `connect_o_auth_config_post_connect_o_auth_config`
|
|
- Route: `POST /v2.1/accounts/{accountId}/connect/oauth`
|
|
- Mode: WRITE
|
|
- Summary: Set up Connect OAuth for the specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### connect_o_auth_config_delete_connect_o_auth_config
|
|
|
|
- Operation ID: `connect_o_auth_config_delete_connect_o_auth_config`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/oauth`
|
|
- Mode: WRITE
|
|
- Summary: Delete the Connect OAuth configuration.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_hmac_get_connect_secret
|
|
|
|
- Operation ID: `connect_hmac_get_connect_secret`
|
|
- Route: `GET /v2.1/accounts/{accountId}/connect/secret`
|
|
- Mode: READ
|
|
- Summary: ConnectHMAC_GetConnectSecret
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_hmac_create_connect_secret
|
|
|
|
- Operation ID: `connect_hmac_create_connect_secret`
|
|
- Route: `POST /v2.1/accounts/{accountId}/connect/secret`
|
|
- Mode: WRITE
|
|
- Summary: Generates a new connect HMAC Secret.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### connect_hmac_delete_connect_secret
|
|
|
|
- Operation ID: `connect_hmac_delete_connect_secret`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/connect/secret/{keyId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes the connect HMAC Secret for specified account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `keyId` in `path` required
|
|
|
|
### consumer_disclosure_get_consumer_disclosure
|
|
|
|
- Operation ID: `consumer_disclosure_get_consumer_disclosure`
|
|
- Route: `GET /v2.1/accounts/{accountId}/consumer_disclosure`
|
|
- Mode: READ
|
|
- Summary: Gets the default Electronic Record and Signature Disclosure for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `langCode` in `query`
|
|
|
|
### consumer_disclosure_get_consumer_disclosure_lang_code
|
|
|
|
- Operation ID: `consumer_disclosure_get_consumer_disclosure_lang_code`
|
|
- Route: `GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}`
|
|
- Mode: READ
|
|
- Summary: Gets the Electronic Record and Signature Disclosure for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `langCode` in `path` required
|
|
|
|
### consumer_disclosure_put_consumer_disclosure
|
|
|
|
- Operation ID: `consumer_disclosure_put_consumer_disclosure`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}`
|
|
- Mode: WRITE
|
|
- Summary: Updates the Electronic Record and Signature Disclosure for an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `langCode` in `path` required
|
|
- `include_metadata` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### contacts_put_contacts
|
|
|
|
- Operation ID: `contacts_put_contacts`
|
|
- Route: `PUT /v2.1/accounts/{accountId}/contacts`
|
|
- Mode: WRITE
|
|
- Summary: Updates one or more contacts.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### contacts_post_contacts
|
|
|
|
- Operation ID: `contacts_post_contacts`
|
|
- Route: `POST /v2.1/accounts/{accountId}/contacts`
|
|
- Mode: WRITE
|
|
- Summary: Add contacts to a contacts list.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### contacts_delete_contacts
|
|
|
|
- Operation ID: `contacts_delete_contacts`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/contacts`
|
|
- Mode: WRITE
|
|
- Summary: Deletes multiple contacts from an account.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### contacts_get_contact_by_id
|
|
|
|
- Operation ID: `contacts_get_contact_by_id`
|
|
- Route: `GET /v2.1/accounts/{accountId}/contacts/{contactId}`
|
|
- Mode: READ
|
|
- Summary: Gets one or more contacts.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `contactId` in `path` required
|
|
- `cloud_provider` in `query`
|
|
|
|
### contacts_delete_contact_with_id
|
|
|
|
- Operation ID: `contacts_delete_contact_with_id`
|
|
- Route: `DELETE /v2.1/accounts/{accountId}/contacts/{contactId}`
|
|
- Mode: WRITE
|
|
- Summary: Deletes a contact.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `contactId` in `path` required
|
|
|
|
### account_custom_fields_get_account_custom_fields
|
|
|
|
- Operation ID: `account_custom_fields_get_account_custom_fields`
|
|
- Route: `GET /v2.1/accounts/{accountId}/custom_fields`
|
|
- Mode: READ
|
|
- Summary: Gets a list of custom fields.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
|
|
### account_custom_fields_post_account_custom_fields
|
|
|
|
- Operation ID: `account_custom_fields_post_account_custom_fields`
|
|
- Route: `POST /v2.1/accounts/{accountId}/custom_fields`
|
|
- Mode: WRITE
|
|
- Summary: Creates an account custom field.
|
|
- Parameters:
|
|
- `accountId` in `path` required
|
|
- `apply_to_templates` in `query`
|
|
- Body: JSON request body accepted.
|