{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:docusign/service-information-get-service-information":{"get":{"operationId":"ecommerce_docusign_service_information_get_service_information","summary":"Retrieves the available REST API versions.","description":"GET /service_information","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/service-information-get-resource-information":{"get":{"operationId":"ecommerce_docusign_service_information_get_resource_information","summary":"Lists resources for REST version specified","description":"GET /v2.1","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/accounts-post-accounts":{"post":{"operationId":"ecommerce_docusign_accounts_post_accounts","summary":"Creates new accounts.","description":"POST /v2.1/accounts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/accounts-get-account":{"get":{"operationId":"ecommerce_docusign_accounts_get_account","summary":"Retrieves the account information for the specified account.","description":"GET /v2.1/accounts/{accountId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"include_account_settings","in":"query","required":false,"description":"When **true,** includes account settings in the response. The default value is **false.**","schema":{"type":"string","description":"When **true,** includes account settings in the response. The default value is **false.**"}},{"name":"include_trial_eligibility","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/accounts-delete-account":{"post":{"operationId":"ecommerce_docusign_accounts_delete_account","summary":"Deletes the specified account.","description":"DELETE /v2.1/accounts/{accountId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"redact_user_data":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-charges-get-account-billing-charges":{"get":{"operationId":"ecommerce_docusign_billing_charges_get_account_billing_charges","summary":"Gets list of recurring and usage charges for the account.","description":"GET /v2.1/accounts/{accountId}/billing_charges","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"include_charges","in":"query","required":false,"description":"Specifies which billing charges to return. Valid values are: * envelopes * seats","schema":{"type":"string","description":"Specifies which billing charges to return. Valid values are: * envelopes * seats"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-invoices-get-billing-invoices":{"get":{"operationId":"ecommerce_docusign_billing_invoices_get_billing_invoices","summary":"Get a List of Billing Invoices","description":"GET /v2.1/accounts/{accountId}/billing_invoices","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"from_date","in":"query","required":false,"description":"Specifies the date/time of the earliest invoice in the account to retrieve.","schema":{"type":"string","description":"Specifies the date/time of the earliest invoice in the account to retrieve."}},{"name":"to_date","in":"query","required":false,"description":"Specifies the date/time of the latest invoice in the account to retrieve.","schema":{"type":"string","description":"Specifies the date/time of the latest invoice in the account to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-invoices-get-billing-invoice":{"get":{"operationId":"ecommerce_docusign_billing_invoices_get_billing_invoice","summary":"Retrieves a billing invoice.","description":"GET /v2.1/accounts/{accountId}/billing_invoices/{invoiceId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"invoiceId","in":"query","required":true,"description":"The ID of the invoice.","schema":{"type":"string","description":"The ID of the invoice."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-invoices-get-billing-invoices-past-due":{"get":{"operationId":"ecommerce_docusign_billing_invoices_get_billing_invoices_past_due","summary":"Get a list of past due invoices.","description":"GET /v2.1/accounts/{accountId}/billing_invoices_past_due","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-payments-get-payment-list":{"get":{"operationId":"ecommerce_docusign_billing_payments_get_payment_list","summary":"Gets payment information for one or more payments.","description":"GET /v2.1/accounts/{accountId}/billing_payments","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"from_date","in":"query","required":false,"description":"Specifies the date/time of the earliest payment in the account to retrieve.","schema":{"type":"string","description":"Specifies the date/time of the earliest payment in the account to retrieve."}},{"name":"to_date","in":"query","required":false,"description":"Specifies the date/time of the latest payment in the account to retrieve.","schema":{"type":"string","description":"Specifies the date/time of the latest payment in the account to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-payments-post-payment":{"post":{"operationId":"ecommerce_docusign_billing_payments_post_payment","summary":"Posts a payment to a past due invoice.","description":"POST /v2.1/accounts/{accountId}/billing_payments","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-payments-get-payment":{"get":{"operationId":"ecommerce_docusign_billing_payments_get_payment","summary":"Gets billing payment information for a specific payment.","description":"GET /v2.1/accounts/{accountId}/billing_payments/{paymentId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"paymentId","in":"query","required":true,"description":"The ID of the payment.","schema":{"type":"string","description":"The ID of the payment."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plan-get-billing-plan":{"get":{"operationId":"ecommerce_docusign_billing_plan_get_billing_plan","summary":"Get Account Billing Plan","description":"GET /v2.1/accounts/{accountId}/billing_plan","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"include_credit_card_information","in":"query","required":false,"description":"When **true,** payment information including credit card information will show in the return.","schema":{"type":"string","description":"When **true,** payment information including credit card information will show in the return."}},{"name":"include_downgrade_information","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","required":false,"description":"When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to…","schema":{"type":"string","description":"When **true,** the `canUpgrade` and `renewalStatus` properties are included the response and an array of `supportedCountries` is added to…"}},{"name":"include_successor_plans","in":"query","required":false,"description":"When **true,** excludes successor information from the response.","schema":{"type":"string","description":"When **true,** excludes successor information from the response."}},{"name":"include_tax_exempt_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plan-put-billing-plan":{"post":{"operationId":"ecommerce_docusign_billing_plan_put_billing_plan","summary":"Updates an account billing plan.","description":"PUT /v2.1/accounts/{accountId}/billing_plan","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"preview_billing_plan":{"type":"string","description":"When **true,** updates the account using a preview billing plan."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plan-get-credit-card-info":{"get":{"operationId":"ecommerce_docusign_billing_plan_get_credit_card_info","summary":"Get credit card information","description":"GET /v2.1/accounts/{accountId}/billing_plan/credit_card","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plan-get-downgrade-request-billing-info":{"get":{"operationId":"ecommerce_docusign_billing_plan_get_downgrade_request_billing_info","summary":"Returns downgrade plan information for the specified account.","description":"GET /v2.1/accounts/{accountId}/billing_plan/downgrade","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plan-put-downgrade-account-billing-plan":{"post":{"operationId":"ecommerce_docusign_billing_plan_put_downgrade_account_billing_plan","summary":"Queues downgrade billing plan request for an account.","description":"PUT /v2.1/accounts/{accountId}/billing_plan/downgrade","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/purchased-envelopes-put-purchased-envelopes":{"post":{"operationId":"ecommerce_docusign_purchased_envelopes_put_purchased_envelopes","summary":"Reserved: Purchase additional envelopes.","description":"PUT /v2.1/accounts/{accountId}/billing_plan/purchased_envelopes","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-get-brands":{"get":{"operationId":"ecommerce_docusign_brands_get_brands","summary":"Gets a list of brands.","description":"GET /v2.1/accounts/{accountId}/brands","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"exclude_distributor_brand","in":"query","required":false,"description":"When **true,** excludes distributor brand information from the response set.","schema":{"type":"string","description":"When **true,** excludes distributor brand information from the response set."}},{"name":"include_logos","in":"query","required":false,"description":"When **true,** returns the logos associated with the brand.","schema":{"type":"string","description":"When **true,** returns the logos associated with the brand."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-post-brands":{"post":{"operationId":"ecommerce_docusign_brands_post_brands","summary":"Creates one or more brand profiles for an account.","description":"POST /v2.1/accounts/{accountId}/brands","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-delete-brands":{"post":{"operationId":"ecommerce_docusign_brands_delete_brands","summary":"Deletes one or more brand profiles.","description":"DELETE /v2.1/accounts/{accountId}/brands","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-get-brand":{"get":{"operationId":"ecommerce_docusign_brand_get_brand","summary":"Gets information about a brand.","description":"GET /v2.1/accounts/{accountId}/brands/{brandId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"brandId","in":"query","required":true,"description":"The ID of the brand.","schema":{"type":"string","description":"The ID of the brand."}},{"name":"include_external_references","in":"query","required":false,"description":"When **true,** the landing pages and links associated with the brand are included in the response.","schema":{"type":"string","description":"When **true,** the landing pages and links associated with the brand are included in the response."}},{"name":"include_logos","in":"query","required":false,"description":"When **true,** the URIs for the logos associated with the brand are included in the response.","schema":{"type":"string","description":"When **true,** the URIs for the logos associated with the brand are included in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-put-brand":{"post":{"operationId":"ecommerce_docusign_brand_put_brand","summary":"Updates an existing brand.","description":"PUT /v2.1/accounts/{accountId}/brands/{brandId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","brandId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"brandId":{"type":"string","description":"The ID of the brand."},"replace_brand":{"type":"string","description":"When **true,** replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-delete-brand":{"post":{"operationId":"ecommerce_docusign_brand_delete_brand","summary":"Deletes a brand.","description":"DELETE /v2.1/accounts/{accountId}/brands/{brandId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","brandId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"brandId":{"type":"string","description":"The ID of the brand."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-export-get-brand-export-file":{"get":{"operationId":"ecommerce_docusign_brand_export_get_brand_export_file","summary":"Exports a brand.","description":"GET /v2.1/accounts/{accountId}/brands/{brandId}/file","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"brandId","in":"query","required":true,"description":"The ID of the brand.","schema":{"type":"string","description":"The ID of the brand."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-logo-get-brand-logo":{"get":{"operationId":"ecommerce_docusign_brand_logo_get_brand_logo","summary":"Gets a brand logo.","description":"GET /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"brandId","in":"query","required":true,"description":"The ID of the brand.","schema":{"type":"string","description":"The ID of the brand."}},{"name":"logoType","in":"query","required":true,"description":"The type of logo. Valid values are: - `primary` - `secondary` - `email`","schema":{"type":"string","description":"The type of logo. Valid values are: - `primary` - `secondary` - `email`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-logo-put-brand-logo":{"post":{"operationId":"ecommerce_docusign_brand_logo_put_brand_logo","summary":"Updates a brand logo.","description":"PUT /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","brandId","logoType"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"brandId":{"type":"string","description":"The ID of the brand."},"logoType":{"type":"string","description":"The type of logo. Valid values are: - `primary` - `secondary` - `email`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-logo-delete-brand-logo":{"post":{"operationId":"ecommerce_docusign_brand_logo_delete_brand_logo","summary":"Deletes a brand logo.","description":"DELETE /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","brandId","logoType"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"brandId":{"type":"string","description":"The ID of the brand."},"logoType":{"type":"string","description":"The type of logo. Valid values are: - `primary` - `secondary` - `email`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-resources-get-brand-resources-list":{"get":{"operationId":"ecommerce_docusign_brand_resources_get_brand_resources_list","summary":"Returns metadata about the branding resources for an account.","description":"GET /v2.1/accounts/{accountId}/brands/{brandId}/resources","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"brandId","in":"query","required":true,"description":"The ID of the brand.","schema":{"type":"string","description":"The ID of the brand."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-resources-get-brand-resources":{"get":{"operationId":"ecommerce_docusign_brand_resources_get_brand_resources","summary":"Returns a branding resource file.","description":"GET /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"brandId","in":"query","required":true,"description":"The ID of the brand.","schema":{"type":"string","description":"The ID of the brand."}},{"name":"resourceContentType","in":"query","required":true,"description":"The type of brand resource file to return. Valid values are: - `sending` - `signing` - `email` - `signing_captive`","schema":{"type":"string","description":"The type of brand resource file to return. Valid values are: - `sending` - `signing` - `email` - `signing_captive`"}},{"name":"langcode","in":"query","required":false,"description":"The ISO 3166-1 alpha-2 codes for the languages that the brand supports.","schema":{"type":"string","description":"The ISO 3166-1 alpha-2 codes for the languages that the brand supports."}},{"name":"return_master","in":"query","required":false,"description":"Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements…","schema":{"type":"string","description":"Specifies which resource file data to return. When **true,** only the master resource file is returned. When **false,** only the elements…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brand-resources-put-brand-resources":{"post":{"operationId":"ecommerce_docusign_brand_resources_put_brand_resources","summary":"Updates a branding resource file.","description":"PUT /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","brandId","resourceContentType","body"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"brandId":{"type":"string","description":"The ID of the brand."},"resourceContentType":{"type":"string","description":"The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-batch-get-bulk-send-batches":{"get":{"operationId":"ecommerce_docusign_bulk_send_v2_batch_get_bulk_send_batches","summary":"Returns a list of bulk send batch summaries.","description":"GET /v2.1/accounts/{accountId}/bulk_send_batch","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"batch_ids","in":"query","required":false,"description":"A comma-separated list of batch IDs to query.","schema":{"type":"string","description":"A comma-separated list of batch IDs to query."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`…","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`…"}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range in UTC DateTime format.","schema":{"type":"string","description":"The start date for a date range in UTC DateTime format."}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"status","in":"query","required":false,"description":"The kind of results to collect. Must be one of: - all - failed - sent - queued","schema":{"type":"string","description":"The kind of results to collect. Must be one of: - all - failed - sent - queued"}},{"name":"to_date","in":"query","required":false,"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…","schema":{"type":"string","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-batch-get-bulk-send-batch-status":{"get":{"operationId":"ecommerce_docusign_bulk_send_v2_batch_get_bulk_send_batch_status","summary":"Gets the status of a specific bulk send batch.","description":"GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"bulkSendBatchId","in":"query","required":true,"description":"The batch ID.","schema":{"type":"string","description":"The batch ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-batch-put-bulk-send-batch-status":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_batch_put_bulk_send_batch_status","summary":"Updates the name of a bulk send batch.","description":"PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkSendBatchId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkSendBatchId":{"type":"string","description":"The batch ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-batch-put-bulk-send-batch-action":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_batch_put_bulk_send_batch_action","summary":"Applies a bulk action to all envelopes from a specified bulk send.","description":"PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkAction","bulkSendBatchId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkAction":{"type":"string","description":"The action to apply. Valid values: * `resend` * `correct` * `void`"},"bulkSendBatchId":{"type":"string","description":"The batch ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-envelopes-get-bulk-send-batch-envelopes":{"get":{"operationId":"ecommerce_docusign_bulk_send_v2_envelopes_get_bulk_send_batch_envelopes","summary":"Gets envelopes from a specific bulk send batch.","description":"GET /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"bulkSendBatchId","in":"query","required":true,"description":"The batch ID.","schema":{"type":"string","description":"The batch ID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `1000`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `1000`"}},{"name":"include","in":"query","required":false,"description":"When `recipients`, only envelopes with recipient nodes will be included in the response.","schema":{"type":"string","description":"When `recipients`, only envelopes with recipient nodes will be included in the response."}},{"name":"order","in":"query","required":false,"description":"The order in which to sort the results. Valid values are: - Descending order: `desc` (default) - Ascending order: `asc`","schema":{"type":"string","description":"The order in which to sort the results. Valid values are: - Descending order: `desc` (default) - Ascending order: `asc`"}},{"name":"order_by","in":"query","required":false,"description":"The envelope attribute used to sort the results. Valid values are: - `created` (default) - `completed` - `last_modified` - `sent` -…","schema":{"type":"string","description":"The envelope attribute used to sort the results. Valid values are: - `created` (default) - `completed` - `last_modified` - `sent` -…"}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"status","in":"query","required":false,"description":"Comma-separated list of envelope statuses. Note that `any` should not be included with other statuses. In other words, `any` is a valid…","schema":{"type":"string","description":"Comma-separated list of envelope statuses. Note that `any` should not be included with other statuses. In other words, `any` is a valid…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-crud-get-bulk-send-lists":{"get":{"operationId":"ecommerce_docusign_bulk_send_v2_crud_get_bulk_send_lists","summary":"Gets bulk send lists.","description":"GET /v2.1/accounts/{accountId}/bulk_send_lists","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-crud-post-bulk-send-list":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_crud_post_bulk_send_list","summary":"Creates a bulk send list.","description":"POST /v2.1/accounts/{accountId}/bulk_send_lists","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The ID of the account."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-crud-get-bulk-send-list":{"get":{"operationId":"ecommerce_docusign_bulk_send_v2_crud_get_bulk_send_list","summary":"Gets a specific bulk send list.","description":"GET /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"bulkSendListId","in":"query","required":true,"description":"The GUID of the bulk send list. This property is created after you post a new bulk send list.","schema":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-crud-put-bulk-send-list":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_crud_put_bulk_send_list","summary":"Updates a bulk send list.","description":"PUT /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkSendListId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkSendListId":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-crud-delete-bulk-send-list":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_crud_delete_bulk_send_list","summary":"Deletes a bulk send list.","description":"DELETE /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkSendListId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkSendListId":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-send-post-bulk-send-request":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_send_post_bulk_send_request","summary":"Creates a bulk send request.","description":"POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkSendListId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkSendListId":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bulk-send-v2-test-post-bulk-send-test-request":{"post":{"operationId":"ecommerce_docusign_bulk_send_v2_test_post_bulk_send_test_request","summary":"Creates a bulk send test.","description":"POST /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bulkSendListId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bulkSendListId":{"type":"string","description":"The GUID of the bulk send list. This property is created after you post a new bulk send list."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/captive-recipients-delete-captive-recipients-part":{"post":{"operationId":"ecommerce_docusign_captive_recipients_delete_captive_recipients_part","summary":"Deletes the signature for one or more captive recipient records.","description":"DELETE /v2.1/accounts/{accountId}/captive_recipients/{recipientPart}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientPart"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientPart":{"type":"string","description":"Signature is the only supported value."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/chunked-uploads-post-chunked-uploads":{"post":{"operationId":"ecommerce_docusign_chunked_uploads_post_chunked_uploads","summary":"Initiate a new chunked upload.","description":"POST /v2.1/accounts/{accountId}/chunked_uploads","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/chunked-uploads-get-chunked-upload":{"get":{"operationId":"ecommerce_docusign_chunked_uploads_get_chunked_upload","summary":"Retrieves metadata about a chunked upload.","description":"GET /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"chunkedUploadId","in":"query","required":true,"description":"The ID of the chunked upload.","schema":{"type":"string","description":"The ID of the chunked upload."}},{"name":"include","in":"query","required":false,"description":"(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`,…","schema":{"type":"string","description":"(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is `checksum`,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/chunked-uploads-put-chunked-uploads":{"post":{"operationId":"ecommerce_docusign_chunked_uploads_put_chunked_uploads","summary":"Commit a chunked upload.","description":"PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","chunkedUploadId"],"properties":{"accountId":{"type":"string","description":"(Required) The external account number (int) or account ID GUID."},"chunkedUploadId":{"type":"string","description":"(Required) The ID of the chunked upload to commit."},"action":{"type":"string","description":"(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/chunked-uploads-delete-chunked-upload":{"post":{"operationId":"ecommerce_docusign_chunked_uploads_delete_chunked_upload","summary":"Deletes a chunked upload.","description":"DELETE /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","chunkedUploadId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"chunkedUploadId":{"type":"string","description":"The ID of the chunked upload."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/chunked-uploads-put-chunked-upload-part":{"post":{"operationId":"ecommerce_docusign_chunked_uploads_put_chunked_upload_part","summary":"Add a chunk to an existing chunked upload.","description":"PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","chunkedUploadId","chunkedUploadPartSeq"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"chunkedUploadId":{"type":"string","description":"The ID of the chunked upload."},"chunkedUploadPartSeq":{"type":"string","description":"The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-get-connect-configs":{"get":{"operationId":"ecommerce_docusign_connect_get_connect_configs","summary":"Get Connect configuration information.","description":"GET /v2.1/accounts/{accountId}/connect","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-post-connect-configuration":{"post":{"operationId":"ecommerce_docusign_connect_post_connect_configuration","summary":"Creates a Connect configuration.","description":"POST /v2.1/accounts/{accountId}/connect","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-put-connect-configuration":{"post":{"operationId":"ecommerce_docusign_connect_put_connect_configuration","summary":"Updates a specified Connect configuration.","description":"PUT /v2.1/accounts/{accountId}/connect","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-get-connect-config":{"get":{"operationId":"ecommerce_docusign_connect_get_connect_config","summary":"Gets the details about a Connect configuration.","description":"GET /v2.1/accounts/{accountId}/connect/{connectId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"connectId","in":"query","required":true,"description":"The ID of the custom Connect configuration being accessed.","schema":{"type":"string","description":"The ID of the custom Connect configuration being accessed."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-delete-connect-config":{"post":{"operationId":"ecommerce_docusign_connect_delete_connect_config","summary":"Deletes the specified Connect configuration.","description":"DELETE /v2.1/accounts/{accountId}/connect/{connectId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","connectId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"connectId":{"type":"string","description":"The ID of the custom Connect configuration being accessed."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-get-connect-all-users":{"get":{"operationId":"ecommerce_docusign_connect_get_connect_all_users","summary":"Returns all users from the configured Connect service.","description":"GET /v2.1/accounts/{accountId}/connect/{connectId}/all/users","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"connectId","in":"query","required":true,"description":"The ID of the custom Connect configuration being accessed.","schema":{"type":"string","description":"The ID of the custom Connect configuration being accessed."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"domain_users_only","in":"query","required":false,"schema":{"type":"string"}},{"name":"email_substring","in":"query","required":false,"description":"Filters returned user records by full email address or a substring of email address.","schema":{"type":"string","description":"Filters returned user records by full email address or a substring of email address."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}},{"name":"status","in":"query","required":false,"description":"The status of the item.","schema":{"type":"string","description":"The status of the item."}},{"name":"user_name_substring","in":"query","required":false,"description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character.","schema":{"type":"string","description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-get-connect-users":{"get":{"operationId":"ecommerce_docusign_connect_get_connect_users","summary":"Returns users from the configured Connect service.","description":"GET /v2.1/accounts/{accountId}/connect/{connectId}/users","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"connectId","in":"query","required":true,"description":"The ID of the custom Connect configuration being accessed.","schema":{"type":"string","description":"The ID of the custom Connect configuration being accessed."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."}},{"name":"email_substring","in":"query","required":false,"description":"Filters returned user records by full email address or a substring of email address.","schema":{"type":"string","description":"Filters returned user records by full email address or a substring of email address."}},{"name":"list_included_users","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"status","in":"query","required":false,"description":"Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired *…","schema":{"type":"string","description":"Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired *…"}},{"name":"user_name_substring","in":"query","required":false,"description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character.","schema":{"type":"string","description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-publish-put-connect-retry-by-envelope":{"post":{"operationId":"ecommerce_docusign_connect_publish_put_connect_retry_by_envelope","summary":"Republishes Connect information for the specified envelope.","description":"PUT /v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/historical-envelope-publish-post-historical-envelope-publish":{"post":{"operationId":"ecommerce_docusign_historical_envelope_publish_post_historical_envelope_publish","summary":"Submits a batch of historical envelopes for republish to a webhook.","description":"POST /v2.1/accounts/{accountId}/connect/envelopes/publish/historical","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-publish-put-connect-retry":{"post":{"operationId":"ecommerce_docusign_connect_publish_put_connect_retry","summary":"Republishes Connect information for multiple envelopes.","description":"PUT /v2.1/accounts/{accountId}/connect/envelopes/retry_queue","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-failures-get-connect-logs":{"get":{"operationId":"ecommerce_docusign_connect_failures_get_connect_logs","summary":"Gets the Connect failure log information.","description":"GET /v2.1/accounts/{accountId}/connect/failures","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.","schema":{"type":"string","description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied."}},{"name":"to_date","in":"query","required":false,"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…","schema":{"type":"string","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-failures-delete-connect-failure-log":{"post":{"operationId":"ecommerce_docusign_connect_failures_delete_connect_failure_log","summary":"Deletes a Connect failure log entry.","description":"DELETE /v2.1/accounts/{accountId}/connect/failures/{failureId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","failureId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"failureId":{"type":"string","description":"The ID of the Connect post failure. Use `all` to delete all failures for the account."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-log-get-connect-logs":{"get":{"operationId":"ecommerce_docusign_connect_log_get_connect_logs","summary":"Gets the Connect log.","description":"GET /v2.1/accounts/{accountId}/connect/logs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.","schema":{"type":"string","description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied."}},{"name":"to_date","in":"query","required":false,"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…","schema":{"type":"string","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-log-delete-connect-logs":{"post":{"operationId":"ecommerce_docusign_connect_log_delete_connect_logs","summary":"Deletes a list of Connect log entries.","description":"DELETE /v2.1/accounts/{accountId}/connect/logs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-log-get-connect-log":{"get":{"operationId":"ecommerce_docusign_connect_log_get_connect_log","summary":"Gets a Connect log entry.","description":"GET /v2.1/accounts/{accountId}/connect/logs/{logId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"logId","in":"query","required":true,"description":"The ID of the Connect log entry.","schema":{"type":"string","description":"The ID of the Connect log entry."}},{"name":"additional_info","in":"query","required":false,"description":"When **true,** the response includes the `connectDebugLog` information.","schema":{"type":"string","description":"When **true,** the response includes the `connectDebugLog` information."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-log-delete-connect-log":{"post":{"operationId":"ecommerce_docusign_connect_log_delete_connect_log","summary":"Deletes a specified Connect log entry.","description":"DELETE /v2.1/accounts/{accountId}/connect/logs/{logId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","logId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"logId":{"type":"string","description":"The ID of the Connect log entry. Use `all` to delete all entries for the account."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-oauth-config-get-connect-oauth-config":{"get":{"operationId":"ecommerce_docusign_connect_oauth_config_get_connect_oauth_config","summary":"Retrieves the Connect OAuth information for the account.","description":"GET /v2.1/accounts/{accountId}/connect/oauth","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-oauth-config-post-connect-oauth-config":{"post":{"operationId":"ecommerce_docusign_connect_oauth_config_post_connect_oauth_config","summary":"Set up Connect OAuth for the specified account.","description":"POST /v2.1/accounts/{accountId}/connect/oauth","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-oauth-config-put-connect-oauth-config":{"post":{"operationId":"ecommerce_docusign_connect_oauth_config_put_connect_oauth_config","summary":"Updates the existing Connect OAuth configuration for the account.","description":"PUT /v2.1/accounts/{accountId}/connect/oauth","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-oauth-config-delete-connect-oauth-config":{"post":{"operationId":"ecommerce_docusign_connect_oauth_config_delete_connect_oauth_config","summary":"Delete the Connect OAuth configuration.","description":"DELETE /v2.1/accounts/{accountId}/connect/oauth","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-hmac-get-connect-secret":{"get":{"operationId":"ecommerce_docusign_connect_hmac_get_connect_secret","summary":"GET /v2.1/accounts/{accountId}/connect/secret","description":"GET /v2.1/accounts/{accountId}/connect/secret","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-hmac-create-connect-secret":{"post":{"operationId":"ecommerce_docusign_connect_hmac_create_connect_secret","summary":"Generates a new connect HMAC Secret.","description":"POST /v2.1/accounts/{accountId}/connect/secret","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/connect-hmac-delete-connect-secret":{"post":{"operationId":"ecommerce_docusign_connect_hmac_delete_connect_secret","summary":"Deletes the connect HMAC Secret for specified account.","description":"DELETE /v2.1/accounts/{accountId}/connect/secret/{keyId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","keyId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"keyId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure":{"get":{"operationId":"ecommerce_docusign_consumer_disclosure_get_consumer_disclosure","summary":"Gets the default Electronic Record and Signature Disclosure for an account.","description":"GET /v2.1/accounts/{accountId}/consumer_disclosure","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"langCode","in":"query","required":false,"description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic…","schema":{"type":"string","description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure-lang-code":{"get":{"operationId":"ecommerce_docusign_consumer_disclosure_get_consumer_disclosure_lang_code","summary":"Gets the Electronic Record and Signature Disclosure for an account.","description":"GET /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"langCode","in":"query","required":true,"description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic…","schema":{"type":"string","description":"The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/consumer-disclosure-put-consumer-disclosure":{"post":{"operationId":"ecommerce_docusign_consumer_disclosure_put_consumer_disclosure","summary":"Updates the Electronic Record and Signature Disclosure for an account.","description":"PUT /v2.1/accounts/{accountId}/consumer_disclosure/{langCode}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","langCode"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"langCode":{"type":"string","description":"The code for the signer language version of the disclosure that you want to update. The following languages are supported: - Arabic (`ar`)…"},"include_metadata":{"type":"string","description":"(Optional) When true, the response includes metadata indicating which properties are editable."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/contacts-post-contacts":{"post":{"operationId":"ecommerce_docusign_contacts_post_contacts","summary":"Add contacts to a contacts list.","description":"POST /v2.1/accounts/{accountId}/contacts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/contacts-put-contacts":{"post":{"operationId":"ecommerce_docusign_contacts_put_contacts","summary":"Updates one or more contacts.","description":"PUT /v2.1/accounts/{accountId}/contacts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/contacts-delete-contacts":{"post":{"operationId":"ecommerce_docusign_contacts_delete_contacts","summary":"Deletes multiple contacts from an account.","description":"DELETE /v2.1/accounts/{accountId}/contacts","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/contacts-get-contact-by-id":{"get":{"operationId":"ecommerce_docusign_contacts_get_contact_by_id","summary":"Gets one or more contacts.","description":"GET /v2.1/accounts/{accountId}/contacts/{contactId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"contactId","in":"query","required":true,"description":"The ID of a contact person in the account's address book. **Note:** To return all contacts, omit this parameter. It is not required.","schema":{"type":"string","description":"The ID of a contact person in the account's address book. **Note:** To return all contacts, omit this parameter. It is not required."}},{"name":"cloud_provider","in":"query","required":false,"description":"(Optional) The cloud provider from which to retrieve the contacts. Valid values are: - `rooms` - `docusignCore` (default)","schema":{"type":"string","description":"(Optional) The cloud provider from which to retrieve the contacts. Valid values are: - `rooms` - `docusignCore` (default)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/contacts-delete-contact-with-id":{"post":{"operationId":"ecommerce_docusign_contacts_delete_contact_with_id","summary":"Deletes a contact.","description":"DELETE /v2.1/accounts/{accountId}/contacts/{contactId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","contactId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"contactId":{"type":"string","description":"The ID of a contact person in the account's address book."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-custom-fields-get-account-custom-fields":{"get":{"operationId":"ecommerce_docusign_account_custom_fields_get_account_custom_fields","summary":"Gets a list of custom fields.","description":"GET /v2.1/accounts/{accountId}/custom_fields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-custom-fields-post-account-custom-fields":{"post":{"operationId":"ecommerce_docusign_account_custom_fields_post_account_custom_fields","summary":"Creates an account custom field.","description":"POST /v2.1/accounts/{accountId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"apply_to_templates":{"type":"string","description":"(Optional) When **true,** the new custom field is applied to all of the templates on the account."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-custom-fields-put-account-custom-fields":{"post":{"operationId":"ecommerce_docusign_account_custom_fields_put_account_custom_fields","summary":"Updates an account custom field.","description":"PUT /v2.1/accounts/{accountId}/custom_fields/{customFieldId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","customFieldId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"customFieldId":{"type":"string","description":"The ID of the custom field."},"apply_to_templates":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-custom-fields-delete-account-custom-fields":{"post":{"operationId":"ecommerce_docusign_account_custom_fields_delete_account_custom_fields","summary":"Deletes an account custom field.","description":"DELETE /v2.1/accounts/{accountId}/custom_fields/{customFieldId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","customFieldId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"customFieldId":{"type":"string","description":"The ID of the custom field."},"apply_to_templates":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-get-envelopes":{"get":{"operationId":"ecommerce_docusign_envelopes_get_envelopes","summary":"Search for specific sets of envelopes by using search filters.","description":"GET /v2.1/accounts/{accountId}/envelopes","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"ac_status","in":"query","required":false,"description":"Specifies the authoritative copy status for the envelopes. Valid values: * `Unknown` * `Original` * `Transferred` * `AuthoritativeCopy` *…","schema":{"type":"string","description":"Specifies the authoritative copy status for the envelopes. Valid values: * `Unknown` * `Original` * `Transferred` * `AuthoritativeCopy` *…"}},{"name":"block","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"cdse_mode","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"continuation_token","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. The maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or…","schema":{"type":"string","description":"The maximum number of results to return. The maximum value is 1000. To get the next or previous set of envelopes, use `nextUri` or…"}},{"name":"custom_field","in":"query","required":false,"description":"Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format:…","schema":{"type":"string","description":"Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format:…"}},{"name":"email","in":"query","required":false,"description":"Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and…","schema":{"type":"string","description":"Limit results to envelopes sent by the account user with this email address. `user_name` must be given as well, and both `email` and…"}},{"name":"envelope_ids","in":"query","required":false,"description":"Comma separated list of `envelopeId` values.","schema":{"type":"string","description":"Comma separated list of `envelopeId` values."}},{"name":"exclude","in":"query","required":false,"description":"Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values: - `recipients` -…","schema":{"type":"string","description":"Excludes information from the response. Enter as a comma-separated list (e.g., `folders,powerforms`). Valid values: - `recipients` -…"}},{"name":"folder_ids","in":"query","required":false,"description":"Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values: -…","schema":{"type":"string","description":"Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values: -…"}},{"name":"folder_types","in":"query","required":false,"description":"Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values: - `normal` - `inbox` -…","schema":{"type":"string","description":"Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values: - `normal` - `inbox` -…"}},{"name":"from_date","in":"query","required":false,"description":"Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are…","schema":{"type":"string","description":"Specifies the date and time to start looking for status changes. This parameter is required unless `envelopeIds` or `transactionIds` are…"}},{"name":"from_to_status","in":"query","required":false,"description":"This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created…","schema":{"type":"string","description":"This is the status type checked for in the `from_date`/`to_date` period. For example, if `Created` is specified, then envelopes created…"}},{"name":"include","in":"query","required":false,"description":"Specifies additional information to return about the envelopes. Use a comma-separated list, such as `folders, recipients` to specify…","schema":{"type":"string","description":"Specifies additional information to return about the envelopes. Use a comma-separated list, such as `folders, recipients` to specify…"}},{"name":"include_purge_information","in":"query","required":false,"description":"When **true,** information about envelopes that have been deleted is included in the response.","schema":{"type":"string","description":"When **true,** information about envelopes that have been deleted is included in the response."}},{"name":"intersecting_folder_ids","in":"query","required":false,"description":"A comma-separated list of folders from which you want to get envelopes. Valid values: - `normal` - `inbox` - `sentitems` - `draft` -…","schema":{"type":"string","description":"A comma-separated list of folders from which you want to get envelopes. Valid values: - `normal` - `inbox` - `sentitems` - `draft` -…"}},{"name":"last_queried_date","in":"query","required":false,"description":"Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z`","schema":{"type":"string","description":"Returns envelopes that were modified prior to the specified date and time. Example: `2020-05-09T21:56:12.2500000Z`"}},{"name":"order","in":"query","required":false,"description":"Returns envelopes in either ascending (`asc`) or descending (`desc`) order.","schema":{"type":"string","description":"Returns envelopes in either ascending (`asc`) or descending (`desc`) order."}},{"name":"order_by","in":"query","required":false,"description":"Sorts results according to a specific property. Valid values: - `last_modified` - `action_required` - `created` - `completed` -…","schema":{"type":"string","description":"Sorts results according to a specific property. Valid values: - `last_modified` - `action_required` - `created` - `completed` -…"}},{"name":"powerformids","in":"query","required":false,"description":"A comma-separated list of `PowerFormId` values.","schema":{"type":"string","description":"A comma-separated list of `PowerFormId` values."}},{"name":"query_budget","in":"query","required":false,"description":"The time in seconds that the query should run before returning data.","schema":{"type":"string","description":"The time in seconds that the query should run before returning data."}},{"name":"requester_date_format","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"search_text","in":"query","required":false,"description":"Free text search criteria that you can use to filter the list of envelopes that is returned.","schema":{"type":"string","description":"Free text search criteria that you can use to filter the list of envelopes that is returned."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"status","in":"query","required":false,"description":"A comma-separated list of current envelope statuses to be included in the response. Valid values: * `completed` * `created` * `declined` *…","schema":{"type":"string","description":"A comma-separated list of current envelope statuses to be included in the response. Valid values: * `completed` * `created` * `declined` *…"}},{"name":"to_date","in":"query","required":false,"description":"Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date…","schema":{"type":"string","description":"Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date…"}},{"name":"transaction_ids","in":"query","required":false,"description":"A comma-separated list of envelope transaction IDs. Getting envelope status by transaction IDs is useful for offline signing situations to…","schema":{"type":"string","description":"A comma-separated list of envelope transaction IDs. Getting envelope status by transaction IDs is useful for offline signing situations to…"}},{"name":"user_filter","in":"query","required":false,"description":"Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid…","schema":{"type":"string","description":"Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, `user_filter=sender`.) Valid…"}},{"name":"user_id","in":"query","required":false,"description":"The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account…","schema":{"type":"string","description":"The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account…"}},{"name":"user_name","in":"query","required":false,"description":"Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name`…","schema":{"type":"string","description":"Limit results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name`…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-post-envelopes":{"post":{"operationId":"ecommerce_docusign_envelopes_post_envelopes","summary":"Creates an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"cdse_mode":{"type":"string","description":"Reserved for Docusign."},"change_routing_order":{"type":"string","description":"When true, users can define the routing order of recipients while sending documents for signature."},"completed_documents_only":{"type":"string","description":"Reserved for Docusign."},"merge_roles_on_draft":{"type":"string","description":"When **true,** template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-get-envelope":{"get":{"operationId":"ecommerce_docusign_envelopes_get_envelope","summary":"Gets the status of a single envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"advanced_update","in":"query","required":false,"description":"When **true,** envelope information can be added or modified.","schema":{"type":"string","description":"When **true,** envelope information can be added or modified."}},{"name":"include","in":"query","required":false,"description":"Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:…","schema":{"type":"string","description":"Specifies additional information about the envelope to return. Enter a comma-separated list, such as `tabs,recipients`. Valid values are:…"}},{"name":"include_anchor_tab_locations","in":"query","required":false,"description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","schema":{"type":"string","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-put-envelope":{"post":{"operationId":"ecommerce_docusign_envelopes_put_envelope","summary":"Send, void, or modify a draft envelope. Purge documents from a completed envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"advanced_update":{"type":"string","description":"When **true,** allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes."},"recycle_on_void":{"type":"string"},"resend_envelope":{"type":"string","description":"When **true,** sends the specified envelope again."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/attachments-get-attachments":{"get":{"operationId":"ecommerce_docusign_attachments_get_attachments","summary":"Returns a list of envelope attachments associated with a specified envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/attachments-put-attachments":{"post":{"operationId":"ecommerce_docusign_attachments_put_attachments","summary":"Adds one or more envelope attachments to a draft or in-process envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/attachments-delete-attachments":{"post":{"operationId":"ecommerce_docusign_attachments_delete_attachments","summary":"Deletes one or more envelope attachments from a draft envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/attachments-get-attachment":{"get":{"operationId":"ecommerce_docusign_attachments_get_attachment","summary":"Retrieves an envelope attachment from an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"attachmentId","in":"query","required":true,"description":"The unique identifier for the attachment.","schema":{"type":"string","description":"The unique identifier for the attachment."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/attachments-put-attachment":{"post":{"operationId":"ecommerce_docusign_attachments_put_attachment","summary":"Updates an envelope attachment in a draft or in-process envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","attachmentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/audit-events-get-audit-events":{"get":{"operationId":"ecommerce_docusign_audit_events_get_audit_events","summary":"Gets the envelope audit events for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"locale","in":"query","required":false,"description":"The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` -…","schema":{"type":"string","description":"The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/comments-get-comments-transcript":{"get":{"operationId":"ecommerce_docusign_comments_get_comments_transcript","summary":"Gets a PDF transcript of all of the comments in an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"encoding","in":"query","required":false,"description":"(Optional) The encoding to use for the file.","schema":{"type":"string","description":"(Optional) The encoding to use for the file."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-get-custom-fields":{"get":{"operationId":"ecommerce_docusign_custom_fields_get_custom_fields","summary":"Gets the custom field information for the specified envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-post-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_post_custom_fields","summary":"Creates envelope custom fields for an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-put-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_put_custom_fields","summary":"Updates envelope custom fields in an envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-delete-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_delete_custom_fields","summary":"Deletes envelope custom fields for draft and in-process envelopes.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/doc-gen-form-fields-get-envelope-doc-gen-form-fields":{"get":{"operationId":"ecommerce_docusign_doc_gen_form_fields_get_envelope_doc_gen_form_fields","summary":"Returns sender fields for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/doc-gen-form-fields-put-envelope-doc-gen-form-fields":{"post":{"operationId":"ecommerce_docusign_doc_gen_form_fields_put_envelope_doc_gen_form_fields","summary":"Updates sender fields for an envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"update_docgen_formfields_only":{"type":"string","description":"When **false** or omitted, the documents are updated. When **true,** only the form fields are updated. The documents are unchanged."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-get-documents":{"get":{"operationId":"ecommerce_docusign_documents_get_documents","summary":"Gets a list of documents in an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"documents_by_userid","in":"query","required":false,"description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders…","schema":{"type":"string","description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders…"}},{"name":"include_agreement_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_docgen_formfields","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"include_is_edited","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_metadata","in":"query","required":false,"description":"When **true,** the response includes metadata that indicates which properties the sender can edit.","schema":{"type":"string","description":"When **true,** the response includes metadata that indicates which properties the sender can edit."}},{"name":"include_tabs","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"recipient_id","in":"query","required":false,"description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to…","schema":{"type":"string","description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to…"}},{"name":"shared_user_id","in":"query","required":false,"description":"The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in…","schema":{"type":"string","description":"The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-put-documents":{"post":{"operationId":"ecommerce_docusign_documents_put_documents","summary":"Adds one or more documents to an existing envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-delete-documents":{"post":{"operationId":"ecommerce_docusign_documents_delete_documents","summary":"Deletes documents from a draft envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-get-document":{"get":{"operationId":"ecommerce_docusign_documents_get_document","summary":"Retrieves a single document or all documents from an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The ID of the document to retrieve. Alternatively, you can use one of the following special keywords: - `combined`: Retrieves all of the…","schema":{"type":"string","description":"The ID of the document to retrieve. Alternatively, you can use one of the following special keywords: - `combined`: Retrieves all of the…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"certificate","in":"query","required":false,"description":"Used only when the `documentId` parameter is the special keyword `combined`. When **true,** the certificate of completion is included in…","schema":{"type":"string","description":"Used only when the `documentId` parameter is the special keyword `combined`. When **true,** the certificate of completion is included in…"}},{"name":"documents_by_userid","in":"query","required":false,"description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders…","schema":{"type":"string","description":"When **true,** allows recipients to get documents by their user id. For example, if a user is included in two different routing orders…"}},{"name":"encoding","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"encrypt","in":"query","required":false,"description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can…","schema":{"type":"string","description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can…"}},{"name":"language","in":"query","required":false,"description":"Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese…","schema":{"type":"string","description":"Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese…"}},{"name":"recipient_id","in":"query","required":false,"description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to…","schema":{"type":"string","description":"Allows the sender to retrieve the documents as one of the recipients that they control. The `documents_by_userid` parameter must be set to…"}},{"name":"shared_user_id","in":"query","required":false,"description":"The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in…","schema":{"type":"string","description":"The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in…"}},{"name":"show_changes","in":"query","required":false,"description":"When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The…","schema":{"type":"string","description":"When **true,** any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The…"}},{"name":"watermark","in":"query","required":false,"description":"When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is…","schema":{"type":"string","description":"When **true,** the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-put-document":{"post":{"operationId":"ecommerce_docusign_documents_put_document","summary":"Adds or replaces a document in an existing envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-get-document-fields":{"get":{"operationId":"ecommerce_docusign_document_fields_get_document_fields","summary":"Gets the custom document fields from an existing envelope document.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-post-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_post_document_fields","summary":"Creates custom document fields in an existing envelope document.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-put-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_put_document_fields","summary":"Updates existing custom document fields in an existing envelope document.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-delete-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_delete_document_fields","summary":"Deletes custom document fields from an existing envelope document.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-get-envelope-document-html-definitions":{"get":{"operationId":"ecommerce_docusign_responsive_html_get_envelope_document_html_definitions","summary":"Retrieves the HTML definition used to generate a dynamically sized responsive document.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The GUID of the document. Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744","schema":{"type":"string","description":"The GUID of the document. Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-get-page-images":{"get":{"operationId":"ecommerce_docusign_pages_get_page_images","summary":"Returns document page images based on input.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"dpi","in":"query","required":false,"description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","schema":{"type":"string","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94."}},{"name":"max_height","in":"query","required":false,"description":"Sets the maximum height of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum height of the returned images in pixels."}},{"name":"max_width","in":"query","required":false,"description":"Sets the maximum width of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum width of the returned images in pixels."}},{"name":"nocache","in":"query","required":false,"description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.","schema":{"type":"string","description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value."}},{"name":"show_changes","in":"query","required":false,"description":"When **true,** changes display in the user interface.","schema":{"type":"string","description":"When **true,** changes display in the user interface."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-delete-page":{"post":{"operationId":"ecommerce_docusign_pages_delete_page","summary":"Deletes a page from a document in an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId","pageNumber"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"pageNumber":{"type":"string","description":"The page number being accessed."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-get-page-image":{"get":{"operationId":"ecommerce_docusign_pages_get_page_image","summary":"Gets a page image from an envelope for display.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"pageNumber","in":"query","required":true,"description":"The page number being accessed.","schema":{"type":"string","description":"The page number being accessed."}},{"name":"dpi","in":"query","required":false,"description":"Sets the dots per inch (DPI) for the returned image.","schema":{"type":"string","description":"Sets the dots per inch (DPI) for the returned image."}},{"name":"max_height","in":"query","required":false,"description":"Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.","schema":{"type":"string","description":"Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting."}},{"name":"max_width","in":"query","required":false,"description":"Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.","schema":{"type":"string","description":"Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting."}},{"name":"show_changes","in":"query","required":false,"description":"When **true,** changes display in the user interface.","schema":{"type":"string","description":"When **true,** changes display in the user interface."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-put-page-image":{"post":{"operationId":"ecommerce_docusign_pages_put_page_image","summary":"Rotates page image from an envelope for display.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId","pageNumber"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"pageNumber":{"type":"string","description":"The page number being accessed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-get-page-tabs":{"get":{"operationId":"ecommerce_docusign_tabs_get_page_tabs","summary":"Returns tabs on the specified page.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"pageNumber","in":"query","required":true,"description":"The page number being accessed.","schema":{"type":"string","description":"The page number being accessed."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-post-document-responsive-html-preview":{"post":{"operationId":"ecommerce_docusign_responsive_html_post_document_responsive_html_preview","summary":"Creates a preview of the responsive version of a document.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-get-document-tabs":{"get":{"operationId":"ecommerce_docusign_tabs_get_document_tabs","summary":"Returns the tabs on a document.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"include_metadata","in":"query","required":false,"description":"When **true,** the response includes metadata indicating which properties are editable.","schema":{"type":"string","description":"When **true,** the response includes metadata indicating which properties are editable."}},{"name":"page_numbers","in":"query","required":false,"description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. Example: `page_numbers=2,6`…","schema":{"type":"string","description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. Example: `page_numbers=2,6`…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-post-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_post_document_tabs","summary":"Adds tabs to a document in an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-put-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_put_document_tabs","summary":"Updates the tabs for document.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-delete-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_delete_document_tabs","summary":"Deletes tabs from a document in an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-get-document-templates":{"get":{"operationId":"ecommerce_docusign_templates_get_document_templates","summary":"Gets the templates associated with a document in an existing envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"include","in":"query","required":false,"description":"A comma-separated list that limits the results. Valid values are: * `applied` * `matched`","schema":{"type":"string","description":"A comma-separated list that limits the results. Valid values are: * `applied` * `matched`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-post-document-templates":{"post":{"operationId":"ecommerce_docusign_templates_post_document_templates","summary":"Adds templates to a document in an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"preserve_template_recipient":{"type":"string","description":"If omitted or set to false (the default), envelope recipients _will be removed_ if the template being applied includes only tabs…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-delete-document-templates":{"post":{"operationId":"ecommerce_docusign_templates_delete_document_templates","summary":"Deletes a template from a document in an existing envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","envelopeId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"templateId":{"type":"string","description":"The ID of the template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/email-settings-get-email-settings":{"get":{"operationId":"ecommerce_docusign_email_settings_get_email_settings","summary":"Gets the email setting overrides for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/email-settings-post-email-settings":{"post":{"operationId":"ecommerce_docusign_email_settings_post_email_settings","summary":"Adds email setting overrides to an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/email-settings-put-email-settings":{"post":{"operationId":"ecommerce_docusign_email_settings_put_email_settings","summary":"Updates the email setting overrides for an envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/email-settings-delete-email-settings":{"post":{"operationId":"ecommerce_docusign_email_settings_delete_email_settings","summary":"Deletes the email setting overrides for an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/form-data-get-form-data":{"get":{"operationId":"ecommerce_docusign_form_data_get_form_data","summary":"Returns envelope tab data for an existing envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-get-envelope-html-definitions":{"get":{"operationId":"ecommerce_docusign_responsive_html_get_envelope_html_definitions","summary":"Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-get-envelope-lock":{"get":{"operationId":"ecommerce_docusign_lock_get_envelope_lock","summary":"Gets envelope lock information.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-post-envelope-lock":{"post":{"operationId":"ecommerce_docusign_lock_post_envelope_lock","summary":"Locks an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-put-envelope-lock":{"post":{"operationId":"ecommerce_docusign_lock_put_envelope_lock","summary":"Updates an envelope lock.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-delete-envelope-lock":{"post":{"operationId":"ecommerce_docusign_lock_delete_envelope_lock","summary":"Deletes an envelope lock.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-get-envelopes-envelope-id-notification":{"get":{"operationId":"ecommerce_docusign_notification_get_envelopes_envelope_id_notification","summary":"Gets envelope notification information.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-put-envelopes-envelope-id-notification":{"post":{"operationId":"ecommerce_docusign_notification_put_envelopes_envelope_id_notification","summary":"Sets envelope notifications for an existing envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipients":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipients","summary":"Gets the status of recipients for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"include_anchor_tab_locations","in":"query","required":false,"description":"When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response.","schema":{"type":"string","description":"When **true** and `include_tabs` value is set to **true,** all tabs with anchor tab properties are included in the response."}},{"name":"include_extended","in":"query","required":false,"description":"When **true,** the extended properties are included in the response.","schema":{"type":"string","description":"When **true,** the extended properties are included in the response."}},{"name":"include_metadata","in":"query","required":false,"description":"Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).","schema":{"type":"string","description":"Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates)."}},{"name":"include_tabs","in":"query","required":false,"description":"When **true,** the tab information associated with the recipient is included in the response.","schema":{"type":"string","description":"When **true,** the tab information associated with the recipient is included in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-post-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_post_recipients","summary":"Adds one or more recipients to an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"resend_envelope":{"type":"string","description":"When **true,** forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipients","summary":"Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"combine_same_order_recipients":{"type":"string","description":"When **true,** recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template…"},"offline_signing":{"type":"string","description":"Indicates if offline signing is enabled for the recipient when a network connection is unavailable."},"resend_envelope":{"type":"string","description":"When **true,** forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_delete_recipients","summary":"Deletes recipients from an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-recipient":{"post":{"operationId":"ecommerce_docusign_recipients_delete_recipient","summary":"Deletes a recipient from an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure-envelope-id-reci":{"get":{"operationId":"ecommerce_docusign_consumer_disclosure_get_consumer_disclosure_envelope_id_reci","summary":"Gets the default Electronic Record and Signature Disclosure for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"langCode","in":"query","required":false,"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: -…","schema":{"type":"string","description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/consumer-disclosure-get-consumer-disclosure-envelope-id-reci-2":{"get":{"operationId":"ecommerce_docusign_consumer_disclosure_get_consumer_disclosure_envelope_id_reci_2","summary":"Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"langCode","in":"query","required":true,"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following…","schema":{"type":"string","description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following…"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"langCode","in":"query","required":false,"description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following…","schema":{"type":"string","description":"(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipient-document-visibility":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipient_document_visibility","summary":"Returns document visibility for a recipient","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipient-document-visibility":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipient_document_visibility","summary":"Updates document visibility for a recipient","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-post-recipient-proof-file-resource-token":{"post":{"operationId":"ecommerce_docusign_recipients_post_recipient_proof_file_resource_token","summary":"Creates a resource token for a sender to request ID Evidence data.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The account ID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"The `recipientIdGuid`."},"token_scopes":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipient-initials-image":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipient_initials_image","summary":"Gets the initials image for a user.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"include_chrome","in":"query","required":false,"description":"Obsolete. The chrome is included in the image if it's present in the envelope.","schema":{"type":"string","description":"Obsolete. The chrome is included in the image if it's present in the envelope."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipient-initials-image":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipient_initials_image","summary":"Sets the initials image for an accountless signer.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipient-signature":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipient_signature","summary":"Gets signature information for a signer or sign-in-person recipient.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipient-signature-image":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipient_signature_image","summary":"Retrieve signature image information for a signer/sign-in-person recipient.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"include_chrome","in":"query","required":false,"description":"Obsolete. The chrome is included in the image if it's present in the envelope.","schema":{"type":"string","description":"Obsolete. The chrome is included in the image if it's present in the envelope."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipient-signature-image":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipient_signature_image","summary":"Sets the signature image for an accountless signer.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-recipient-tabs":{"get":{"operationId":"ecommerce_docusign_recipients_get_recipient_tabs","summary":"Gets the tabs information for a signer or sign-in-person recipient in an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"include_anchor_tab_locations","in":"query","required":false,"description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","schema":{"type":"string","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**"}},{"name":"include_metadata","in":"query","required":false,"description":"When **true,** the response includes metadata indicating which properties are editable.","schema":{"type":"string","description":"When **true,** the response includes metadata indicating which properties are editable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-post-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_post_recipient_tabs","summary":"Adds tabs for a recipient.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipient_tabs","summary":"Updates the tabs for a recipient.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_delete_recipient_tabs","summary":"Deletes the tabs associated with a recipient. **Note:** It is an error to delete a tab that has the…","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-recipient-manual-review-view":{"post":{"operationId":"ecommerce_docusign_views_post_recipient_manual_review_view","summary":"Create the link to the page for manually reviewing IDs.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/views/identity_manual_review","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","recipientId"],"properties":{"accountId":{"type":"string","description":"A value that identifies your account. This value is automatically generated by Docusign for any account you create. Copy the value from…"},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"recipientId":{"type":"string","description":"A GUID value that Docusign assigns to identify each recipient in an envelope. This value is globally unique for all recipients, not just…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-recipients-document-visibility":{"post":{"operationId":"ecommerce_docusign_recipients_put_recipients_document_visibility","summary":"Updates document visibility for recipients","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-post-responsive-html-preview":{"post":{"operationId":"ecommerce_docusign_responsive_html_post_responsive_html_preview","summary":"Creates a preview of the responsive versions of all of the documents in an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-get-envelopes-shares":{"get":{"operationId":"ecommerce_docusign_envelopes_shares_get_envelopes_shares","summary":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-post-envelopes-shares":{"post":{"operationId":"ecommerce_docusign_envelopes_shares_post_envelopes_shares","summary":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-put-envelopes-shares":{"post":{"operationId":"ecommerce_docusign_envelopes_shares_put_envelopes_shares","summary":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-delete-envelopes-shares":{"post":{"operationId":"ecommerce_docusign_envelopes_shares_delete_envelopes_shares","summary":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-get-envelopes-share":{"get":{"operationId":"ecommerce_docusign_envelopes_shares_get_envelopes_share","summary":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"shareId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-put-envelopes-share":{"post":{"operationId":"ecommerce_docusign_envelopes_shares_put_envelopes_share","summary":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","shareId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"shareId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-shares-delete-envelopes-share":{"post":{"operationId":"ecommerce_docusign_envelopes_shares_delete_envelopes_share","summary":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","shareId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"shareId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-blob-get-tabs-blob":{"get":{"operationId":"ecommerce_docusign_tabs_blob_get_tabs_blob","summary":"Reserved for Docusign.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-blob-put-tabs-blob":{"post":{"operationId":"ecommerce_docusign_tabs_blob_put_tabs_blob","summary":"Reserved for Docusign.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-get-envelope-templates":{"get":{"operationId":"ecommerce_docusign_templates_get_envelope_templates","summary":"Gets templates used in an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"include","in":"query","required":false,"description":"Filters the results by template type. Valid values: * `applied`: Returns the templates applied to an envelope. * `matching`: Returns the…","schema":{"type":"string","description":"Filters the results by template type. Valid values: * `applied`: Returns the templates applied to an envelope. * `matching`: Returns the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-post-envelope-templates":{"post":{"operationId":"ecommerce_docusign_templates_post_envelope_templates","summary":"Adds templates to an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"preserve_template_recipient":{"type":"string","description":"If omitted or set to false (the default), envelope recipients _will be removed_ if the template being applied includes only tabs…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-correct-view":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_correct_view","summary":"Returns a URL to the envelope correction UI. Use after an envelope has been sent.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-delete-envelope-correct-view":{"post":{"operationId":"ecommerce_docusign_views_delete_envelope_correct_view","summary":"Revokes the correction view URL to the Envelope UI.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-edit-view":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_edit_view","summary":"Returns a URL to the edit view UI. Use before an envelope has been sent.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-recipient-view":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_recipient_view","summary":"Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also…","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The ID of the draft envelope or template to preview."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-recipient-preview":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_recipient_preview","summary":"Creates an envelope recipient preview.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-sender-view":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_sender_view","summary":"Returns a URL to the sender view UI. Used before an envelope has been sent.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-envelope-recipient-shared-view":{"post":{"operationId":"ecommerce_docusign_views_post_envelope_recipient_shared_view","summary":"Returns a URL to the shared recipient view UI for an envelope.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-definition-v2-get-envelope-workflow-defini":{"get":{"operationId":"ecommerce_docusign_envelope_workflow_definition_v2_get_envelope_workflow_defini","summary":"Returns the workflow definition for an envelope.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-definition-v2-put-envelope-workflow-defini":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_definition_v2_put_envelope_workflow_defini","summary":"Updates the workflow definition for an envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-definition-v2-delete-envelope-workflow-def":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_definition_v2_delete_envelope_workflow_def","summary":"Delete the workflow definition for an envelope.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-scheduled-sending-get-envelope-scheduled-s":{"get":{"operationId":"ecommerce_docusign_envelope_workflow_scheduled_sending_get_envelope_scheduled_s","summary":"Returns the scheduled sending rules for an envelope's workflow definition.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-scheduled-sending-put-envelope-scheduled-s":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_scheduled_sending_put_envelope_scheduled_s","summary":"Updates the scheduled sending rules for an envelope's workflow.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-scheduled-sending-delete-envelope-schedule":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_scheduled_sending_delete_envelope_schedule","summary":"Deletes the scheduled sending rules for the envelope's workflow.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-step-post-envelope-workflow-step-definitio":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_step_post_envelope_workflow_step_definitio","summary":"Adds a new step to an envelope's workflow.","description":"POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-step-get-envelope-workflow-step-definition":{"get":{"operationId":"ecommerce_docusign_envelope_workflow_step_get_envelope_workflow_step_definition","summary":"Returns a specified workflow step for a specified template.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"workflowStepId","in":"query","required":true,"description":"The ID of the workflow step.","schema":{"type":"string","description":"The ID of the workflow step."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-step-put-envelope-workflow-step-definition":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_step_put_envelope_workflow_step_definition","summary":"Updates the specified workflow step for an envelope.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"workflowStepId":{"type":"string","description":"The ID of the workflow step."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-step-delete-envelope-workflow-step-definit":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_step_delete_envelope_workflow_step_definit","summary":"Deletes a workflow step from an envelope's workflow definition.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"workflowStepId":{"type":"string","description":"The ID of the workflow step."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-delayed-routing-get-envelope-delayed-routi":{"get":{"operationId":"ecommerce_docusign_envelope_workflow_delayed_routing_get_envelope_delayed_routi","summary":"Returns the delayed routing rules for an envelope's workflow step definition.","description":"GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"envelopeId","in":"query","required":true,"description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`","schema":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"}},{"name":"workflowStepId","in":"query","required":true,"description":"The ID of the workflow step.","schema":{"type":"string","description":"The ID of the workflow step."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-delayed-routing-put-envelope-delayed-routi":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_delayed_routing_put_envelope_delayed_routi","summary":"Updates the delayed routing rules for an envelope's workflow step definition.","description":"PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"workflowStepId":{"type":"string","description":"The ID of the workflow step."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-workflow-delayed-routing-delete-envelope-delayed-ro":{"post":{"operationId":"ecommerce_docusign_envelope_workflow_delayed_routing_delete_envelope_delayed_ro","summary":"Deletes the delayed routing rules for the specified envelope workflow step.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeId":{"type":"string","description":"The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`"},"workflowStepId":{"type":"string","description":"The ID of the workflow step."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/shared-envelopes-list-get-shared-envelopes":{"get":{"operationId":"ecommerce_docusign_shared_envelopes_list_get_shared_envelopes","summary":"GET /v2.1/accounts/{accountId}/envelopes/shared","description":"GET /v2.1/accounts/{accountId}/envelopes/shared","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.","schema":{"type":"string","description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied."}},{"name":"include","in":"query","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.","schema":{"type":"string","description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order."}},{"name":"order_by","in":"query","required":false,"description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`","schema":{"type":"string","description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`"}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}},{"name":"status","in":"query","required":false,"description":"The status of the item.","schema":{"type":"string","description":"The status of the item."}},{"name":"to_date","in":"query","required":false,"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…","schema":{"type":"string","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelopes-put-status":{"post":{"operationId":"ecommerce_docusign_envelopes_put_status","summary":"Gets envelope statuses for a set of envelopes.","description":"PUT /v2.1/accounts/{accountId}/envelopes/status","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"ac_status":{"type":"string","description":"Specifies the Authoritative Copy Status for the envelopes. Valid values: - `Unknown` - `Original` - `Transferred` - `AuthoritativeCopy` -…"},"block":{"type":"string","description":"When **true,** removes any results that match one of the provided `transaction_ids`."},"count":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."},"email":{"type":"string","description":"The email address of the sender."},"envelope_ids":{"type":"string","description":"The envelope IDs to include in the results. The value of this property can be: * For the `GET` implementation of this method, use a…"},"from_date":{"type":"string","description":"The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required…"},"from_to_status":{"type":"string","description":"The envelope status that you are checking for. Possible values are: - `Changed` (default) - `Completed` - `Created` - `Declined` -…"},"start_position":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"},"status":{"type":"string","description":"A comma-separated list of envelope status to search for. Possible values are: - `completed` - `created` - `declined` - `deleted` -…"},"to_date":{"type":"string","description":"Optional date/time setting that specifies the last date/time or envelope status changes in the result set. The default value is the time…"},"transaction_ids":{"type":"string","description":"The transaction IDs to include in the results. Note that transaction IDs are valid for seven days. The value of this property can be: - A…"},"user_name":{"type":"string","description":"Limits results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name`…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-transfer-rules-get-envelope-transfer-rules":{"get":{"operationId":"ecommerce_docusign_envelope_transfer_rules_get_envelope_transfer_rules","summary":"Gets envelope transfer rules.","description":"GET /v2.1/accounts/{accountId}/envelopes/transfer_rules","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-transfer-rules-post-envelope-transfer-rules":{"post":{"operationId":"ecommerce_docusign_envelope_transfer_rules_post_envelope_transfer_rules","summary":"Creates an envelope transfer rule.","description":"POST /v2.1/accounts/{accountId}/envelopes/transfer_rules","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-transfer-rules-put-envelope-transfer-rules":{"post":{"operationId":"ecommerce_docusign_envelope_transfer_rules_put_envelope_transfer_rules","summary":"Changes the status of multiple envelope transfer rules.","description":"PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-transfer-rules-put-envelope-transfer-rule":{"post":{"operationId":"ecommerce_docusign_envelope_transfer_rules_put_envelope_transfer_rule","summary":"Changes the status of an envelope transfer rule.","description":"PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeTransferRuleId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeTransferRuleId":{"type":"string","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-transfer-rules-delete-envelope-transfer-rules":{"post":{"operationId":"ecommerce_docusign_envelope_transfer_rules_delete_envelope_transfer_rules","summary":"Deletes an envelope transfer rule.","description":"DELETE /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","envelopeTransferRuleId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"envelopeTransferRuleId":{"type":"string","description":"The ID of the envelope transfer rule. The system generates this ID when the rule is first created."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/favorite-templates-get-favorite-templates":{"get":{"operationId":"ecommerce_docusign_favorite_templates_get_favorite_templates","summary":"Retrieves the list of favorite templates for the account.","description":"GET /v2.1/accounts/{accountId}/favorite_templates","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/favorite-templates-put-favorite-template":{"post":{"operationId":"ecommerce_docusign_favorite_templates_put_favorite_template","summary":"Set one or more templates as account favorites.","description":"PUT /v2.1/accounts/{accountId}/favorite_templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/favorite-templates-un-favorite-template":{"post":{"operationId":"ecommerce_docusign_favorite_templates_un_favorite_template","summary":"Remove one or more templates from the account favorites.","description":"DELETE /v2.1/accounts/{accountId}/favorite_templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/folders-get-folders":{"get":{"operationId":"ecommerce_docusign_folders_get_folders","summary":"Returns a list of the account's folders.","description":"GET /v2.1/accounts/{accountId}/folders","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"include","in":"query","required":false,"description":"A comma-separated list of folder types to include in the response. Valid values are: - `envelope_folders`: Returns a list of envelope…","schema":{"type":"string","description":"A comma-separated list of folder types to include in the response. Valid values are: - `envelope_folders`: Returns a list of envelope…"}},{"name":"include_items","in":"query","required":false,"description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.","schema":{"type":"string","description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. The default value is `0`.","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. The default value is `0`."}},{"name":"sub_folder_depth","in":"query","required":false,"description":"If missing or any value other than `-1`, the returned list contains only the top-level folders. A value of `-1` returns the complete…","schema":{"type":"string","description":"If missing or any value other than `-1`, the returned list contains only the top-level folders. A value of `-1` returns the complete…"}},{"name":"template","in":"query","required":false,"description":"This parameter is deprecated as of version 2.1. Use `include` instead.","schema":{"type":"string","description":"This parameter is deprecated as of version 2.1. Use `include` instead."}},{"name":"user_filter","in":"query","required":false,"description":"Narrows down the resulting folder list by the following values: - `all`: Returns all templates owned or shared with the user. (default) -…","schema":{"type":"string","description":"Narrows down the resulting folder list by the following values: - `all`: Returns all templates owned or shared with the user. (default) -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/folders-get-folder-items":{"get":{"operationId":"ecommerce_docusign_folders_get_folder_items","summary":"Gets information about items in a specified folder.","description":"GET /v2.1/accounts/{accountId}/folders/{folderId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"folderId","in":"query","required":true,"description":"The ID of the folder.","schema":{"type":"string","description":"The ID of the folder."}},{"name":"from_date","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"include_items","in":"query","required":false,"description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.","schema":{"type":"string","description":"Indicates whether folder items are included in the response. If this parameter is omitted, the default is false."}},{"name":"owner_email","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"owner_name","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"search_text","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"start_position","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"status","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}},{"name":"to_date","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/folders-put-folder-by-id":{"post":{"operationId":"ecommerce_docusign_folders_put_folder_by_id","summary":"Moves a set of envelopes from their current folder to another folder.","description":"PUT /v2.1/accounts/{accountId}/folders/{folderId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","folderId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"folderId":{"type":"string","description":"The ID of the folder."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-get-groups":{"get":{"operationId":"ecommerce_docusign_groups_get_groups","summary":"Gets information about groups associated with the account.","description":"GET /v2.1/accounts/{accountId}/groups","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`"}},{"name":"group_type","in":"query","required":false,"description":"The type of group to return. Valid values: * `AdminGroup` * `CustomGroup` * `EveryoneGroup`","schema":{"type":"string","description":"The type of group to return. Valid values: * `AdminGroup` * `CustomGroup` * `EveryoneGroup`"}},{"name":"include_usercount","in":"query","required":false,"description":"When **true,** every group returned in the response includes a `userCount` property that contains the total number of users in the group.…","schema":{"type":"string","description":"When **true,** every group returned in the response includes a `userCount` property that contains the total number of users in the group.…"}},{"name":"search_text","in":"query","required":false,"description":"Filters the results of a GET request based on the text that you specify.","schema":{"type":"string","description":"Filters the results of a GET request based on the text that you specify."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-post-groups":{"post":{"operationId":"ecommerce_docusign_groups_post_groups","summary":"Creates one or more groups for the account.","description":"POST /v2.1/accounts/{accountId}/groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-put-groups":{"post":{"operationId":"ecommerce_docusign_groups_put_groups","summary":"Updates the group information for a group.","description":"PUT /v2.1/accounts/{accountId}/groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-delete-groups":{"post":{"operationId":"ecommerce_docusign_groups_delete_groups","summary":"Deletes an existing user group.","description":"DELETE /v2.1/accounts/{accountId}/groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-get-group-brands":{"get":{"operationId":"ecommerce_docusign_brands_get_group_brands","summary":"Gets the brand information for a group.","description":"GET /v2.1/accounts/{accountId}/groups/{groupId}/brands","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"groupId","in":"query","required":true,"description":"The ID of the group.","schema":{"type":"string","description":"The ID of the group."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-put-group-brands":{"post":{"operationId":"ecommerce_docusign_brands_put_group_brands","summary":"Adds an existing brand to a group.","description":"PUT /v2.1/accounts/{accountId}/groups/{groupId}/brands","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","groupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"groupId":{"type":"string","description":"The ID of the group being accessed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/brands-delete-group-brands":{"post":{"operationId":"ecommerce_docusign_brands_delete_group_brands","summary":"Deletes brand information from a group.","description":"DELETE /v2.1/accounts/{accountId}/groups/{groupId}/brands","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","groupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"groupId":{"type":"string","description":"The ID of the group."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-get-group-users":{"get":{"operationId":"ecommerce_docusign_groups_get_group_users","summary":"Gets a list of users in a group.","description":"GET /v2.1/accounts/{accountId}/groups/{groupId}/users","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"groupId","in":"query","required":true,"description":"The ID of the group being accessed.","schema":{"type":"string","description":"The ID of the group being accessed."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`…","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`…"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-put-group-users":{"post":{"operationId":"ecommerce_docusign_groups_put_group_users","summary":"Adds one or more users to an existing group.","description":"PUT /v2.1/accounts/{accountId}/groups/{groupId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","groupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"groupId":{"type":"string","description":"The ID of the group being accessed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/groups-delete-group-users":{"post":{"operationId":"ecommerce_docusign_groups_delete_group_users","summary":"Deletes one or more users from a group","description":"DELETE /v2.1/accounts/{accountId}/groups/{groupId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","groupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"groupId":{"type":"string","description":"The ID of the group being accessed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-identity-verification-get-account-identity-verificat":{"get":{"operationId":"ecommerce_docusign_account_identity_verification_get_account_identity_verificat","summary":"Retrieves the Identity Verification workflows available to an account.","description":"GET /v2.1/accounts/{accountId}/identity_verification","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"identity_verification_workflow_status","in":"query","required":false,"description":"Filters the workflows returned according to status. Valid values: - `active`: Only active workflows are returned. This is the default. -…","schema":{"type":"string","description":"Filters the workflows returned according to status. Valid values: - `active`: Only active workflows are returned. This is the default. -…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/payment-gateway-accounts-get-all-payment-gateway-accounts":{"get":{"operationId":"ecommerce_docusign_payment_gateway_accounts_get_all_payment_gateway_accounts","summary":"List payment gateway accounts","description":"GET /v2.1/accounts/{accountId}/payment_gateway_accounts","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/permission-profiles-get-permission-profiles":{"get":{"operationId":"ecommerce_docusign_permission_profiles_get_permission_profiles","summary":"Gets a list of permission profiles.","description":"GET /v2.1/accounts/{accountId}/permission_profiles","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"include","in":"query","required":false,"description":"A comma-separated list of additional properties to return in the response. Valid values are: - `user_count`: The total number of users…","schema":{"type":"string","description":"A comma-separated list of additional properties to return in the response. Valid values are: - `user_count`: The total number of users…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/permission-profiles-post-permission-profiles":{"post":{"operationId":"ecommerce_docusign_permission_profiles_post_permission_profiles","summary":"Creates a new permission profile for an account.","description":"POST /v2.1/accounts/{accountId}/permission_profiles","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"include":{"type":"string","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/permission-profiles-get-permission-profile":{"get":{"operationId":"ecommerce_docusign_permission_profiles_get_permission_profile","summary":"Returns a permission profile for an account.","description":"GET /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"permissionProfileId","in":"query","required":true,"description":"The ID of the permission profile. Use [AccountPermissionProfiles:…","schema":{"type":"string","description":"The ID of the permission profile. Use [AccountPermissionProfiles:…"}},{"name":"include","in":"query","required":false,"description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which…","schema":{"type":"string","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/permission-profiles-put-permission-profiles":{"post":{"operationId":"ecommerce_docusign_permission_profiles_put_permission_profiles","summary":"Updates a permission profile.","description":"PUT /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","permissionProfileId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"permissionProfileId":{"type":"string","description":"The ID of the permission profile. Use [AccountPermissionProfiles:…"},"include":{"type":"string","description":"A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/permission-profiles-delete-permission-profiles":{"post":{"operationId":"ecommerce_docusign_permission_profiles_delete_permission_profiles","summary":"Deletes a permission profile from an account.","description":"DELETE /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","permissionProfileId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"permissionProfileId":{"type":"string","description":"The ID of the permission profile. Use [AccountPermissionProfiles:…"},"move_users_to":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-get-power-forms-list":{"get":{"operationId":"ecommerce_docusign_power_forms_get_power_forms_list","summary":"Returns a list of PowerForms.","description":"GET /v2.1/accounts/{accountId}/powerforms","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range. **Note:** If no value is provided, no date filtering is applied.","schema":{"type":"string","description":"The start date for a date range. **Note:** If no value is provided, no date filtering is applied."}},{"name":"order","in":"query","required":false,"description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.","schema":{"type":"string","description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order."}},{"name":"order_by","in":"query","required":false,"description":"The file attribute to use to sort the results. Valid values are: - `sender` - `auth` - `used` - `remaining` - `lastused` - `status` -…","schema":{"type":"string","description":"The file attribute to use to sort the results. Valid values are: - `sender` - `auth` - `used` - `remaining` - `lastused` - `status` -…"}},{"name":"search_fields","in":"query","required":false,"description":"A comma-separated list of additional properties to include in a search. - `sender`: Include sender name and email in the search. -…","schema":{"type":"string","description":"A comma-separated list of additional properties to include in a search. - `sender`: Include sender name and email in the search. -…"}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}},{"name":"to_date","in":"query","required":false,"description":"The end date for a date range. **Note:** If no value is provided, this property defaults to the current date.","schema":{"type":"string","description":"The end date for a date range. **Note:** If no value is provided, this property defaults to the current date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-post-power-form":{"post":{"operationId":"ecommerce_docusign_power_forms_post_power_form","summary":"Creates a new PowerForm","description":"POST /v2.1/accounts/{accountId}/powerforms","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-delete-power-forms-list":{"post":{"operationId":"ecommerce_docusign_power_forms_delete_power_forms_list","summary":"Deletes one or more PowerForms.","description":"DELETE /v2.1/accounts/{accountId}/powerforms","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-get-power-form":{"get":{"operationId":"ecommerce_docusign_power_forms_get_power_form","summary":"Returns a single PowerForm.","description":"GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"powerFormId","in":"query","required":true,"description":"The ID of the PowerForm.","schema":{"type":"string","description":"The ID of the PowerForm."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-put-power-form":{"post":{"operationId":"ecommerce_docusign_power_forms_put_power_form","summary":"Updates an existing PowerForm.","description":"PUT /v2.1/accounts/{accountId}/powerforms/{powerFormId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","powerFormId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"powerFormId":{"type":"string","description":"The ID of the PowerForm."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-delete-power-form":{"post":{"operationId":"ecommerce_docusign_power_forms_delete_power_form","summary":"Deletes a PowerForm.","description":"DELETE /v2.1/accounts/{accountId}/powerforms/{powerFormId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","powerFormId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"powerFormId":{"type":"string","description":"The ID of the PowerForm."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-get-power-form-form-data":{"get":{"operationId":"ecommerce_docusign_power_forms_get_power_form_form_data","summary":"Returns the data that users entered in a PowerForm.","description":"GET /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"powerFormId","in":"query","required":true,"description":"The ID of the PowerForm.","schema":{"type":"string","description":"The ID of the PowerForm."}},{"name":"data_layout","in":"query","required":false,"description":"The layout in which to return the PowerForm data. For each of the following layouts, set the `Accept` header to the corresponding value.…","schema":{"type":"string","description":"The layout in which to return the PowerForm data. For each of the following layouts, set the `Accept` header to the corresponding value.…"}},{"name":"from_date","in":"query","required":false,"description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied.","schema":{"type":"string","description":"The start date for a date range in UTC DateTime format. **Note:** If this property is null, no date filtering is applied."}},{"name":"to_date","in":"query","required":false,"description":"The end date of a date range in UTC DateTime format. The default value is `UtcNow`.","schema":{"type":"string","description":"The end date of a date range in UTC DateTime format. The default value is `UtcNow`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/power-forms-get-power-forms-senders":{"get":{"operationId":"ecommerce_docusign_power_forms_get_power_forms_senders","summary":"Gets PowerForm senders.","description":"GET /v2.1/accounts/{accountId}/powerforms/senders","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signature-providers-get-seal-providers":{"get":{"operationId":"ecommerce_docusign_account_signature_providers_get_seal_providers","summary":"Returns available seals for specified account.","description":"GET /v2.1/accounts/{accountId}/seals","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/search-folders-get-search-folder-contents":{"get":{"operationId":"ecommerce_docusign_search_folders_get_search_folder_contents","summary":"Deprecated. Use Envelopes: listStatusChanges.","description":"GET /v2.1/accounts/{accountId}/search_folders/{searchFolderId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"searchFolderId","in":"query","required":true,"description":"Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are:…","schema":{"type":"string","description":"Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are:…"}},{"name":"all","in":"query","required":false,"description":"Specifies that all envelopes that match the criteria are returned.","schema":{"type":"string","description":"Specifies that all envelopes that match the criteria are returned."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`"}},{"name":"from_date","in":"query","required":false,"description":"Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.","schema":{"type":"string","description":"Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days."}},{"name":"include_recipients","in":"query","required":false,"description":"When **true,** the recipient information is returned in the response.","schema":{"type":"string","description":"When **true,** the recipient information is returned in the response."}},{"name":"order","in":"query","required":false,"description":"Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.","schema":{"type":"string","description":"Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order."}},{"name":"order_by","in":"query","required":false,"description":"Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`,…","schema":{"type":"string","description":"Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`,…"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"to_date","in":"query","required":false,"description":"Specifies the end of the date range to return.","schema":{"type":"string","description":"Specifies the end of the date range to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/settings-get-settings":{"get":{"operationId":"ecommerce_docusign_settings_get_settings","summary":"Gets account settings information.","description":"GET /v2.1/accounts/{accountId}/settings","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/settings-put-settings":{"post":{"operationId":"ecommerce_docusign_settings_put_settings","summary":"Updates the account settings for an account.","description":"PUT /v2.1/accounts/{accountId}/settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bccemail-archive-get-bccemail-archive-list":{"get":{"operationId":"ecommerce_docusign_bccemail_archive_get_bccemail_archive_list","summary":"Gets the BCC email archive configurations for an account.","description":"GET /v2.1/accounts/{accountId}/settings/bcc_email_archives","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bccemail-archive-post-bccemail-archive":{"post":{"operationId":"ecommerce_docusign_bccemail_archive_post_bccemail_archive","summary":"Creates a BCC email archive configuration.","description":"POST /v2.1/accounts/{accountId}/settings/bcc_email_archives","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bccemail-archive-get-bccemail-archive-history-list":{"get":{"operationId":"ecommerce_docusign_bccemail_archive_get_bccemail_archive_history_list","summary":"Gets a BCC email archive configuration and its history.","description":"GET /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"bccEmailArchiveId","in":"query","required":true,"description":"The ID of the BCC email archive configuration.","schema":{"type":"string","description":"The ID of the BCC email archive configuration."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of items to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of items to skip."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/bccemail-archive-delete-bccemail-archive":{"post":{"operationId":"ecommerce_docusign_bccemail_archive_delete_bccemail_archive","summary":"Deletes a BCC email archive configuration.","description":"DELETE /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","bccEmailArchiveId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"bccEmailArchiveId":{"type":"string","description":"The ID of the BCC email archive configuration."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/enote-configuration-get-enote-configuration":{"get":{"operationId":"ecommerce_docusign_enote_configuration_get_enote_configuration","summary":"Returns the configuration information for the eNote eOriginal integration.","description":"GET /v2.1/accounts/{accountId}/settings/enote_configuration","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/enote-configuration-put-enote-configuration":{"post":{"operationId":"ecommerce_docusign_enote_configuration_put_enote_configuration","summary":"Updates configuration information for the eNote eOriginal integration.","description":"PUT /v2.1/accounts/{accountId}/settings/enote_configuration","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/enote-configuration-delete-enote-configuration":{"post":{"operationId":"ecommerce_docusign_enote_configuration_delete_enote_configuration","summary":"Deletes configuration information for the eNote eOriginal integration.","description":"DELETE /v2.1/accounts/{accountId}/settings/enote_configuration","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-purge-configuration-get-envelope-purge-configuratio":{"get":{"operationId":"ecommerce_docusign_envelope_purge_configuration_get_envelope_purge_configuratio","summary":"Gets the envelope purge configuration for an account.","description":"GET /v2.1/accounts/{accountId}/settings/envelope_purge_configuration","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/envelope-purge-configuration-put-envelope-purge-configuratio":{"post":{"operationId":"ecommerce_docusign_envelope_purge_configuration_put_envelope_purge_configuratio","summary":"Sets the envelope purge configuration for an account.","description":"PUT /v2.1/accounts/{accountId}/settings/envelope_purge_configuration","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-defaults-get-notification-defaults":{"get":{"operationId":"ecommerce_docusign_notification_defaults_get_notification_defaults","summary":"Gets envelope notification defaults.","description":"GET /v2.1/accounts/{accountId}/settings/notification_defaults","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-defaults-put-notification-defaults":{"post":{"operationId":"ecommerce_docusign_notification_defaults_put_notification_defaults","summary":"Updates envelope notification default settings.","description":"PUT /v2.1/accounts/{accountId}/settings/notification_defaults","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-password-rules-get-account-password-rules":{"get":{"operationId":"ecommerce_docusign_account_password_rules_get_account_password_rules","summary":"Gets the password rules for an account.","description":"GET /v2.1/accounts/{accountId}/settings/password_rules","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-password-rules-put-account-password-rules":{"post":{"operationId":"ecommerce_docusign_account_password_rules_put_account_password_rules","summary":"Updates the password rules for an account.","description":"PUT /v2.1/accounts/{accountId}/settings/password_rules","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tab-settings-get-tab-settings":{"get":{"operationId":"ecommerce_docusign_tab_settings_get_tab_settings","summary":"Returns tab settings list for specified account","description":"GET /v2.1/accounts/{accountId}/settings/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tab-settings-put-settings":{"post":{"operationId":"ecommerce_docusign_tab_settings_put_settings","summary":"Modifies tab settings for specified account","description":"PUT /v2.1/accounts/{accountId}/settings/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/shared-access-get-shared-access":{"get":{"operationId":"ecommerce_docusign_shared_access_get_shared_access","summary":"Reserved: Gets the shared item status for one or more users.","description":"GET /v2.1/accounts/{accountId}/shared_access","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `1000`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `1000`"}},{"name":"envelopes_not_shared_user_status","in":"query","required":false,"description":"This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the…","schema":{"type":"string","description":"This query parameter works in conjunction with `user_ids`. When you specify one of the following user statuses, the query limits the…"}},{"name":"folder_ids","in":"query","required":false,"description":"A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder…","schema":{"type":"string","description":"A comma-separated list of folder IDs for which to return shared item information. If `item_type` is set to `folders`, at least one folder…"}},{"name":"item_type","in":"query","required":false,"description":"Specifies the type of shared item being requested. Valid values: - `envelopes`: Get information about envelope sharing between users. -…","schema":{"type":"string","description":"Specifies the type of shared item being requested. Valid values: - `envelopes`: Get information about envelope sharing between users. -…"}},{"name":"search_text","in":"query","required":false,"description":"Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.","schema":{"type":"string","description":"Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string."}},{"name":"shared","in":"query","required":false,"description":"A comma-separated list of sharing filters that specifies which users appear in the response. - `not_shared`: The response lists users who…","schema":{"type":"string","description":"A comma-separated list of sharing filters that specifies which users appear in the response. - `not_shared`: The response lists users who…"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"user_ids","in":"query","required":false,"description":"A comma-separated list of user IDs for whom the shared item information is being requested.","schema":{"type":"string","description":"A comma-separated list of user IDs for whom the shared item information is being requested."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/shared-access-put-shared-access":{"post":{"operationId":"ecommerce_docusign_shared_access_put_shared_access","summary":"Reserved: Sets the shared access information for users.","description":"PUT /v2.1/accounts/{accountId}/shared_access","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"item_type":{"type":"string","description":"Specifies the type of shared item being set: - `envelopes`: Set envelope sharing between users. - `templates`: Set information about…"},"preserve_existing_shared_access":{"type":"string","description":"When **true,** preserve the existing shared access settings."},"user_ids":{"type":"string","description":"A comma-separated list of IDs for users whose shared item access is being set."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signature-providers-get-signature-providers":{"get":{"operationId":"ecommerce_docusign_account_signature_providers_get_signature_providers","summary":"Gets the available signature providers for an account.","description":"GET /v2.1/accounts/{accountId}/signatureProviders","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-get-account-signatures":{"get":{"operationId":"ecommerce_docusign_account_signatures_get_account_signatures","summary":"Returns a list of stamps available in the account.","description":"GET /v2.1/accounts/{accountId}/signatures","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"stamp_format","in":"query","required":false,"description":"The format of the stamp to return. Valid values: - `NameDateHanko` - `NameHanko` - `PlaceholderHanko`","schema":{"type":"string","description":"The format of the stamp to return. Valid values: - `NameDateHanko` - `NameHanko` - `PlaceholderHanko`"}},{"name":"stamp_name","in":"query","required":false,"description":"The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.","schema":{"type":"string","description":"The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID."}},{"name":"stamp_type","in":"query","required":false,"description":"The type of the stamps to return. Valid values: - `name_stamp` - `stamp` - `signature`","schema":{"type":"string","description":"The type of the stamps to return. Valid values: - `name_stamp` - `stamp` - `signature`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-post-account-signatures":{"post":{"operationId":"ecommerce_docusign_account_signatures_post_account_signatures","summary":"Adds or updates one or more account stamps.","description":"POST /v2.1/accounts/{accountId}/signatures","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"decode_only":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-put-account-signature":{"post":{"operationId":"ecommerce_docusign_account_signatures_put_account_signature","summary":"Updates an account stamp.","description":"PUT /v2.1/accounts/{accountId}/signatures","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-get-account-signature":{"get":{"operationId":"ecommerce_docusign_account_signatures_get_account_signature","summary":"Returns information about the specified stamp.","description":"GET /v2.1/accounts/{accountId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"signatureId","in":"query","required":true,"description":"The ID of the account stamp.","schema":{"type":"string","description":"The ID of the account stamp."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-put-account-signature-by-id":{"post":{"operationId":"ecommerce_docusign_account_signatures_put_account_signature_by_id","summary":"Updates an account stamp by ID.","description":"PUT /v2.1/accounts/{accountId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signatureId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signatureId":{"type":"string","description":"The ID of the account stamp."},"close_existing_signature":{"type":"string","description":"When **true,** closes the current signature."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-delete-account-signature":{"post":{"operationId":"ecommerce_docusign_account_signatures_delete_account_signature","summary":"Deletes an account stamp.","description":"DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signatureId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signatureId":{"type":"string","description":"The ID of the account stamp."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-get-account-signature-image":{"get":{"operationId":"ecommerce_docusign_account_signatures_get_account_signature_image","summary":"Returns the image for an account stamp.","description":"GET /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"imageType","in":"query","required":true,"description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`","schema":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"}},{"name":"signatureId","in":"query","required":true,"description":"The ID of the account stamp.","schema":{"type":"string","description":"The ID of the account stamp."}},{"name":"include_chrome","in":"query","required":false,"description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.","schema":{"type":"string","description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-put-account-signature-image":{"post":{"operationId":"ecommerce_docusign_account_signatures_put_account_signature_image","summary":"Sets a signature image, initials, or stamp.","description":"PUT /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","imageType","signatureId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"},"signatureId":{"type":"string","description":"The ID of the account stamp."},"transparent_png":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/account-signatures-delete-account-signature-image":{"post":{"operationId":"ecommerce_docusign_account_signatures_delete_account_signature_image","summary":"Deletes the image for a stamp.","description":"DELETE /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","imageType","signatureId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"},"signatureId":{"type":"string","description":"The ID of the account stamp."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-get-signing-groups":{"get":{"operationId":"ecommerce_docusign_signing_groups_get_signing_groups","summary":"Gets a list of the Signing Groups in an account.","description":"GET /v2.1/accounts/{accountId}/signing_groups","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"group_type","in":"query","required":false,"description":"Filters by the type of signing group. Valid values: * `sharedSigningGroup` * `privateSigningGroup` * `systemSigningGroup`","schema":{"type":"string","description":"Filters by the type of signing group. Valid values: * `sharedSigningGroup` * `privateSigningGroup` * `systemSigningGroup`"}},{"name":"include_users","in":"query","required":false,"description":"When **true,** the response includes the signing group members.","schema":{"type":"string","description":"When **true,** the response includes the signing group members."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-post-signing-groups":{"post":{"operationId":"ecommerce_docusign_signing_groups_post_signing_groups","summary":"Creates a signing group.","description":"POST /v2.1/accounts/{accountId}/signing_groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-put-signing-groups":{"post":{"operationId":"ecommerce_docusign_signing_groups_put_signing_groups","summary":"Updates signing group names.","description":"PUT /v2.1/accounts/{accountId}/signing_groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-delete-signing-groups":{"post":{"operationId":"ecommerce_docusign_signing_groups_delete_signing_groups","summary":"Deletes one or more signing groups.","description":"DELETE /v2.1/accounts/{accountId}/signing_groups","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-get-signing-group":{"get":{"operationId":"ecommerce_docusign_signing_groups_get_signing_group","summary":"Gets information about a signing group.","description":"GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"signingGroupId","in":"query","required":true,"description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).","schema":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-put-signing-group":{"post":{"operationId":"ecommerce_docusign_signing_groups_put_signing_group","summary":"Updates a signing group.","description":"PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signingGroupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-get-signing-group-users":{"get":{"operationId":"ecommerce_docusign_signing_groups_get_signing_group_users","summary":"Gets a list of members in a Signing Group.","description":"GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"signingGroupId","in":"query","required":true,"description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).…","schema":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-put-signing-group-users":{"post":{"operationId":"ecommerce_docusign_signing_groups_put_signing_group_users","summary":"Adds members to a signing group.","description":"PUT /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signingGroupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/signing-groups-delete-signing-group-users":{"post":{"operationId":"ecommerce_docusign_signing_groups_delete_signing_group_users","summary":"Deletes one or more members from a signing group.","description":"DELETE /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signingGroupId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signingGroupId":{"type":"string","description":"The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/supported-languages-get-supported-languages":{"get":{"operationId":"ecommerce_docusign_supported_languages_get_supported_languages","summary":"Gets the supported languages for envelope recipients.","description":"GET /v2.1/accounts/{accountId}/supported_languages","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-get-tab-definitions":{"get":{"operationId":"ecommerce_docusign_tabs_get_tab_definitions","summary":"Gets a list of all account tabs.","description":"GET /v2.1/accounts/{accountId}/tab_definitions","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"custom_tab_only","in":"query","required":false,"description":"When **true,** only custom tabs are returned in the response.","schema":{"type":"string","description":"When **true,** only custom tabs are returned in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-post-tab-definitions":{"post":{"operationId":"ecommerce_docusign_tabs_post_tab_definitions","summary":"Creates a custom tab.","description":"POST /v2.1/accounts/{accountId}/tab_definitions","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tab-get-custom-tab":{"get":{"operationId":"ecommerce_docusign_tab_get_custom_tab","summary":"Gets custom tab information.","description":"GET /v2.1/accounts/{accountId}/tab_definitions/{customTabId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"customTabId","in":"query","required":true,"description":"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When…","schema":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tab-put-custom-tab":{"post":{"operationId":"ecommerce_docusign_tab_put_custom_tab","summary":"Updates custom tab information.","description":"PUT /v2.1/accounts/{accountId}/tab_definitions/{customTabId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","customTabId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"customTabId":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tab-delete-custom-tab":{"post":{"operationId":"ecommerce_docusign_tab_delete_custom_tab","summary":"Deletes custom tab information.","description":"DELETE /v2.1/accounts/{accountId}/tab_definitions/{customTabId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","customTabId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"customTabId":{"type":"string","description":"The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-get-templates":{"get":{"operationId":"ecommerce_docusign_templates_get_templates","summary":"Gets the list of templates.","description":"GET /v2.1/accounts/{accountId}/templates","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. **Note:** If the `count` parameter…","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. **Note:** If the `count` parameter…"}},{"name":"created_from_date","in":"query","required":false,"description":"Lists templates created on or after this date.","schema":{"type":"string","description":"Lists templates created on or after this date."}},{"name":"created_to_date","in":"query","required":false,"description":"Lists templates modified before this date.","schema":{"type":"string","description":"Lists templates modified before this date."}},{"name":"folder_ids","in":"query","required":false,"description":"A comma-separated list of folder ID GUIDs.","schema":{"type":"string","description":"A comma-separated list of folder ID GUIDs."}},{"name":"folder_types","in":"query","required":false,"description":"The type of folder to return templates for. Possible values are: - `templates`: Templates in the **My Templates** folder. Templates in the…","schema":{"type":"string","description":"The type of folder to return templates for. Possible values are: - `templates`: Templates in the **My Templates** folder. Templates in the…"}},{"name":"from_date","in":"query","required":false,"description":"Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on…","schema":{"type":"string","description":"Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on…"}},{"name":"include","in":"query","required":false,"description":"A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes details…","schema":{"type":"string","description":"A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes details…"}},{"name":"is_deleted_template_only","in":"query","required":false,"description":"When **true,** retrieves templates that have been permanently deleted. The default is **false.** **Note:** After you delete a template,…","schema":{"type":"string","description":"When **true,** retrieves templates that have been permanently deleted. The default is **false.** **Note:** After you delete a template,…"}},{"name":"is_download","in":"query","required":false,"description":"When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file. The…","schema":{"type":"string","description":"When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file. The…"}},{"name":"link_configuration_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"modified_from_date","in":"query","required":false,"description":"Lists templates modified on or after this date.","schema":{"type":"string","description":"Lists templates modified on or after this date."}},{"name":"modified_to_date","in":"query","required":false,"description":"Lists templates modified before this date.","schema":{"type":"string","description":"Lists templates modified before this date."}},{"name":"order","in":"query","required":false,"description":"Specifies the sort order of the search results. Valid values are: - `asc`: Ascending (A to Z) - `desc`: Descending (Z to A)","schema":{"type":"string","description":"Specifies the sort order of the search results. Valid values are: - `asc`: Ascending (A to Z) - `desc`: Descending (Z to A)"}},{"name":"order_by","in":"query","required":false,"description":"Specifies how the search results are listed. Valid values are: - `name`: template name - `modified`: date/time template was last modified…","schema":{"type":"string","description":"Specifies how the search results are listed. Valid values are: - `name`: template name - `modified`: date/time template was last modified…"}},{"name":"search_fields","in":"query","required":false,"description":"A comma-separated list of additional template properties to search. - `sender`: Include sender name and email in the search. -…","schema":{"type":"string","description":"A comma-separated list of additional template properties to search. - `sender`: Include sender name and email in the search. -…"}},{"name":"search_text","in":"query","required":false,"description":"The text to use to search the names of templates. Limit: 48 characters.","schema":{"type":"string","description":"The text to use to search the names of templates. Limit: 48 characters."}},{"name":"shared_by_me","in":"query","required":false,"description":"When **true,** the response only includes templates shared by the user. When **false,** the response only returns template not shared by…","schema":{"type":"string","description":"When **true,** the response only includes templates shared by the user. When **false,** the response only returns template not shared by…"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"template_ids","in":"query","required":false,"description":"A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**","schema":{"type":"string","description":"A comma-separated list of template IDs to download. This value is valid only when `is_download` is **true.**"}},{"name":"to_date","in":"query","required":false,"description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…","schema":{"type":"string","description":"The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are…"}},{"name":"used_from_date","in":"query","required":false,"description":"Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no…","schema":{"type":"string","description":"Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no…"}},{"name":"used_to_date","in":"query","required":false,"description":"End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the…","schema":{"type":"string","description":"End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the…"}},{"name":"user_filter","in":"query","required":false,"description":"Filters the templates in the response. Valid values are: - `owned_by_me`: Results include only templates owned by the user. -…","schema":{"type":"string","description":"Filters the templates in the response. Valid values are: - `owned_by_me`: Results include only templates owned by the user. -…"}},{"name":"user_id","in":"query","required":false,"description":"The ID of the user.","schema":{"type":"string","description":"The ID of the user."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-post-templates":{"post":{"operationId":"ecommerce_docusign_templates_post_templates","summary":"Creates one or more templates.","description":"POST /v2.1/accounts/{accountId}/templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"(Required) The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-put-templates":{"post":{"operationId":"ecommerce_docusign_templates_put_templates","summary":"PUT /v2.1/accounts/{accountId}/templates","description":"PUT /v2.1/accounts/{accountId}/templates","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-get-template":{"get":{"operationId":"ecommerce_docusign_templates_get_template","summary":"Gets a specific template associated with a specified account.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"include","in":"query","required":false,"description":"A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes…","schema":{"type":"string","description":"A comma-separated list of additional template attributes to include in the response. Valid values are: - `powerforms`: Includes…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-put-template":{"post":{"operationId":"ecommerce_docusign_templates_put_template","summary":"Updates an existing template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-put-template-part":{"post":{"operationId":"ecommerce_docusign_templates_put_template_part","summary":"Shares a template with a group.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","templatePart"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"templatePart":{"type":"string","description":"Currently, the only defined part is **groups.**"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-delete-template-part":{"post":{"operationId":"ecommerce_docusign_templates_delete_template_part","summary":"Removes a member group's sharing permissions for a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","templatePart"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"templatePart":{"type":"string","description":"Currently, the only defined part is **groups.**"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-get-template-custom-fields":{"get":{"operationId":"ecommerce_docusign_custom_fields_get_template_custom_fields","summary":"Gets the custom document fields from a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-post-template-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_post_template_custom_fields","summary":"Creates custom document fields in an existing template document.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-put-template-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_put_template_custom_fields","summary":"Updates envelope custom fields in a template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/custom-fields-delete-template-custom-fields":{"post":{"operationId":"ecommerce_docusign_custom_fields_delete_template_custom_fields","summary":"Deletes envelope custom fields in a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-get-template-documents":{"get":{"operationId":"ecommerce_docusign_documents_get_template_documents","summary":"Gets a list of documents associated with a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"include_agreement_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_is_edited","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_tabs","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-put-template-documents":{"post":{"operationId":"ecommerce_docusign_documents_put_template_documents","summary":"Adds documents to a template document.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-delete-template-documents":{"post":{"operationId":"ecommerce_docusign_documents_delete_template_documents","summary":"Deletes documents from a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-get-template-document":{"get":{"operationId":"ecommerce_docusign_documents_get_template_document","summary":"Gets PDF documents from a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"encrypt","in":"query","required":false,"description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can…","schema":{"type":"string","description":"When **true,** the PDF bytes returned in the response are encrypted for all the key managers configured on your Docusign account. You can…"}},{"name":"file_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"show_changes","in":"query","required":false,"description":"When **true,** any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional…","schema":{"type":"string","description":"When **true,** any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/documents-put-template-document":{"post":{"operationId":"ecommerce_docusign_documents_put_template_document","summary":"Updates a template document.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"is_envelope_definition":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-get-template-document-fields":{"get":{"operationId":"ecommerce_docusign_document_fields_get_template_document_fields","summary":"Gets the custom document fields for a an existing template document.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-post-template-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_post_template_document_fields","summary":"Creates custom document fields in an existing template document.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-put-template-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_put_template_document_fields","summary":"Updates existing custom document fields in an existing template document.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/document-fields-delete-template-document-fields":{"post":{"operationId":"ecommerce_docusign_document_fields_delete_template_document_fields","summary":"Deletes custom document fields from an existing template document.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-get-template-document-html-definitions":{"get":{"operationId":"ecommerce_docusign_responsive_html_get_template_document_html_definitions","summary":"Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-get-template-page-images":{"get":{"operationId":"ecommerce_docusign_pages_get_template_page_images","summary":"Returns document page images based on input.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"(Required) The external account number (int) or account ID GUID.","schema":{"type":"string","description":"(Required) The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"(Required) The ID of the document.","schema":{"type":"string","description":"(Required) The ID of the document."}},{"name":"templateId","in":"query","required":true,"description":"(Required) The ID of the template.","schema":{"type":"string","description":"(Required) The ID of the template."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"dpi","in":"query","required":false,"description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","schema":{"type":"string","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94."}},{"name":"max_height","in":"query","required":false,"description":"Sets the maximum height of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum height of the returned images in pixels."}},{"name":"max_width","in":"query","required":false,"description":"Sets the maximum width of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum width of the returned images in pixels."}},{"name":"nocache","in":"query","required":false,"description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value.","schema":{"type":"string","description":"When **true,** using cache is disabled and image information is retrieved from a database. **True** is the default value."}},{"name":"show_changes","in":"query","required":false,"description":"When **true,** changes display in the user interface.","schema":{"type":"string","description":"When **true,** changes display in the user interface."}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-delete-template-page":{"post":{"operationId":"ecommerce_docusign_pages_delete_template_page","summary":"Deletes a page from a document in an template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","pageNumber","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"pageNumber":{"type":"string","description":"The page number being accessed."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-get-template-page-image":{"get":{"operationId":"ecommerce_docusign_pages_get_template_page_image","summary":"Gets a page image from a template for display.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"pageNumber","in":"query","required":true,"description":"The page number being accessed.","schema":{"type":"string","description":"The page number being accessed."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"dpi","in":"query","required":false,"description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","schema":{"type":"string","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94."}},{"name":"max_height","in":"query","required":false,"description":"Sets the maximum height of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum height of the returned images in pixels."}},{"name":"max_width","in":"query","required":false,"description":"Sets the maximum width of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum width of the returned images in pixels."}},{"name":"show_changes","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/pages-put-template-page-image":{"post":{"operationId":"ecommerce_docusign_pages_put_template_page_image","summary":"Rotates page image from a template for display.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","pageNumber","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"pageNumber":{"type":"string","description":"The page number being accessed."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-get-template-page-tabs":{"get":{"operationId":"ecommerce_docusign_tabs_get_template_page_tabs","summary":"Returns tabs on the specified page.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"pageNumber","in":"query","required":true,"description":"The page number being accessed.","schema":{"type":"string","description":"The page number being accessed."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-post-template-document-responsive-html-previ":{"post":{"operationId":"ecommerce_docusign_responsive_html_post_template_document_responsive_html_previ","summary":"Creates a preview of the responsive version of a template document.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-get-template-document-tabs":{"get":{"operationId":"ecommerce_docusign_tabs_get_template_document_tabs","summary":"Returns tabs on a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…","schema":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"page_numbers","in":"query","required":false,"description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids. Example: `page_numbers=2,6`","schema":{"type":"string","description":"Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids. Example: `page_numbers=2,6`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-post-template-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_post_template_document_tabs","summary":"Adds tabs to a document in a template.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-put-template-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_put_template_document_tabs","summary":"Updates the tabs for a template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/tabs-delete-template-document-tabs":{"post":{"operationId":"ecommerce_docusign_tabs_delete_template_document_tabs","summary":"Deletes tabs from a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","documentId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"documentId":{"type":"string","description":"The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the `documentId` yourself.…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-get-template-html-definitions":{"get":{"operationId":"ecommerce_docusign_responsive_html_get_template_html_definitions","summary":"Gets the Original HTML Definition used to generate the Responsive HTML for the template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-get-template-lock":{"get":{"operationId":"ecommerce_docusign_lock_get_template_lock","summary":"Gets template lock information.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/lock","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-post-template-lock":{"post":{"operationId":"ecommerce_docusign_lock_post_template_lock","summary":"Locks a template.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-put-template-lock":{"post":{"operationId":"ecommerce_docusign_lock_put_template_lock","summary":"Updates a template lock.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/lock-delete-template-lock":{"post":{"operationId":"ecommerce_docusign_lock_delete_template_lock","summary":"Deletes a template lock.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/lock","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-get-templates-template-id-notification":{"get":{"operationId":"ecommerce_docusign_notification_get_templates_template_id_notification","summary":"Gets template notification information.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/notification","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notification-put-templates-template-id-notification":{"post":{"operationId":"ecommerce_docusign_notification_put_templates_template_id_notification","summary":"Updates the notification structure for an existing template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/notification","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-template-recipients":{"get":{"operationId":"ecommerce_docusign_recipients_get_template_recipients","summary":"Gets recipient information from a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"include_anchor_tab_locations","in":"query","required":false,"description":"When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response.","schema":{"type":"string","description":"When **true** and `include_tabs` is set to **true,** all tabs with anchor tab properties are included in the response."}},{"name":"include_extended","in":"query","required":false,"description":"When **true,** the extended properties are included in the response.","schema":{"type":"string","description":"When **true,** the extended properties are included in the response."}},{"name":"include_tabs","in":"query","required":false,"description":"When **true,** the tab information associated with the recipient is included in the response.","schema":{"type":"string","description":"When **true,** the tab information associated with the recipient is included in the response."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-post-template-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_post_template_recipients","summary":"Adds tabs for a recipient.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"resend_envelope":{"type":"string","description":"When **true,** resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-template-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_put_template_recipients","summary":"Updates recipients in a template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"resend_envelope":{"type":"string","description":"When **true,** resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-template-recipients":{"post":{"operationId":"ecommerce_docusign_recipients_delete_template_recipients","summary":"Deletes recipients from a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-template-recipient":{"post":{"operationId":"ecommerce_docusign_recipients_delete_template_recipient","summary":"Deletes the specified recipient file from a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-template-recipient-document-visibility":{"get":{"operationId":"ecommerce_docusign_recipients_get_template_recipient_document_visibility","summary":"Returns document visibility for a template recipient","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-template-recipient-document-visibility":{"post":{"operationId":"ecommerce_docusign_recipients_put_template_recipient_document_visibility","summary":"Updates document visibility for a template recipient","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-get-template-recipient-tabs":{"get":{"operationId":"ecommerce_docusign_recipients_get_template_recipient_tabs","summary":"Gets the tabs information for a signer or sign-in-person recipient in a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"recipientId","in":"query","required":true,"description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…","schema":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"include_anchor_tab_locations","in":"query","required":false,"description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**","schema":{"type":"string","description":"When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**"}},{"name":"include_metadata","in":"query","required":false,"description":"When **true,** the response includes metadata indicating which properties are editable.","schema":{"type":"string","description":"When **true,** the response includes metadata indicating which properties are editable."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-post-template-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_post_template_recipient_tabs","summary":"Adds tabs for a recipient.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-template-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_put_template_recipient_tabs","summary":"Updates the tabs for a recipient.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-delete-template-recipient-tabs":{"post":{"operationId":"ecommerce_docusign_recipients_delete_template_recipient_tabs","summary":"Deletes the tabs associated with a recipient in a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","recipientId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"recipientId":{"type":"string","description":"A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a…"},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/recipients-put-template-recipients-document-visibility":{"post":{"operationId":"ecommerce_docusign_recipients_put_template_recipients_document_visibility","summary":"Updates document visibility for template recipients","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/responsive-html-post-template-responsive-html-preview":{"post":{"operationId":"ecommerce_docusign_responsive_html_post_template_responsive_html_preview","summary":"Creates a preview of the responsive versions of all of the documents associated with a template.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-template-edit-view":{"post":{"operationId":"ecommerce_docusign_views_post_template_edit_view","summary":"Gets a URL for a template edit view.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/views/edit","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-template-recipient-preview":{"post":{"operationId":"ecommerce_docusign_views_post_template_recipient_preview","summary":"Creates a template recipient preview.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-definition-get-template-workflow-definitio":{"get":{"operationId":"ecommerce_docusign_template_workflow_definition_get_template_workflow_definitio","summary":"Returns the workflow definition for a template.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-definition-put-template-workflow-definitio":{"post":{"operationId":"ecommerce_docusign_template_workflow_definition_put_template_workflow_definitio","summary":"Updates the workflow definition for a template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-definition-delete-template-workflow-defini":{"post":{"operationId":"ecommerce_docusign_template_workflow_definition_delete_template_workflow_defini","summary":"Delete the workflow definition for a template.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-scheduled-sending-get-template-scheduled-s":{"get":{"operationId":"ecommerce_docusign_template_workflow_scheduled_sending_get_template_scheduled_s","summary":"Returns the scheduled sending rules for a template's workflow definition.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-scheduled-sending-put-template-scheduled-s":{"post":{"operationId":"ecommerce_docusign_template_workflow_scheduled_sending_put_template_scheduled_s","summary":"Updates the scheduled sending rules for a template's workflow definition.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-scheduled-sending-delete-template-schedule":{"post":{"operationId":"ecommerce_docusign_template_workflow_scheduled_sending_delete_template_schedule","summary":"Deletes the scheduled sending rules for the template's workflow.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-step-post-template-workflow-step-definitio":{"post":{"operationId":"ecommerce_docusign_template_workflow_step_post_template_workflow_step_definitio","summary":"Adds a new step to a template's workflow.","description":"POST /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-step-get-template-workflow-step-definition":{"get":{"operationId":"ecommerce_docusign_template_workflow_step_get_template_workflow_step_definition","summary":"Returns a specified workflow step for a specified envelope.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"workflowStepId","in":"query","required":true,"description":"The ID of the workflow step.","schema":{"type":"string","description":"The ID of the workflow step."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-step-put-template-workflow-step-definition":{"post":{"operationId":"ecommerce_docusign_template_workflow_step_put_template_workflow_step_definition","summary":"Updates a specified workflow step for a template.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"workflowStepId":{"type":"string","description":"The ID of the workflow step."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-step-delete-template-workflow-step-definit":{"post":{"operationId":"ecommerce_docusign_template_workflow_step_delete_template_workflow_step_definit","summary":"Deletes a workflow step from an template's workflow definition.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"workflowStepId":{"type":"string","description":"The ID of the workflow step."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-delayed-routing-get-template-delayed-routi":{"get":{"operationId":"ecommerce_docusign_template_workflow_delayed_routing_get_template_delayed_routi","summary":"Returns the delayed routing rules for a template's workflow step definition.","description":"GET /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"templateId","in":"query","required":true,"description":"The ID of the template.","schema":{"type":"string","description":"The ID of the template."}},{"name":"workflowStepId","in":"query","required":true,"description":"The ID of the workflow step.","schema":{"type":"string","description":"The ID of the workflow step."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-delayed-routing-put-template-delayed-routi":{"post":{"operationId":"ecommerce_docusign_template_workflow_delayed_routing_put_template_delayed_routi","summary":"Updates the delayed routing rules for a template's workflow step.","description":"PUT /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"workflowStepId":{"type":"string","description":"The ID of the workflow step."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/template-workflow-delayed-routing-delete-template-delayed-ro":{"post":{"operationId":"ecommerce_docusign_template_workflow_delayed_routing_delete_template_delayed_ro","summary":"Deletes the delayed routing rules for the specified template workflow step.","description":"DELETE /v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","templateId","workflowStepId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"templateId":{"type":"string","description":"The ID of the template."},"workflowStepId":{"type":"string","description":"The ID of the workflow step."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/templates-auto-match-put-templates":{"post":{"operationId":"ecommerce_docusign_templates_auto_match_put_templates","summary":"PUT /v2.1/accounts/{accountId}/templates/auto_match","description":"PUT /v2.1/accounts/{accountId}/templates/auto_match","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/unsupported-file-types-get-unsupported-file-types":{"get":{"operationId":"ecommerce_docusign_unsupported_file_types_get_unsupported_file_types","summary":"Gets a list of unsupported file types.","description":"GET /v2.1/accounts/{accountId}/unsupported_file_types","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/users-get-users":{"get":{"operationId":"ecommerce_docusign_users_get_users","summary":"Retrieves the list of users for the specified account. You can filter the users list to get specific users.","description":"GET /v2.1/accounts/{accountId}/users","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"(Required) The external account number (int) or account ID GUID.","schema":{"type":"string","description":"(Required) The external account number (int) or account ID GUID."}},{"name":"additional_info","in":"query","required":false,"description":"When **true,** the custom settings information is returned for each user in the account. If this parameter is omitted, the default…","schema":{"type":"string","description":"When **true,** the custom settings information is returned for each user in the account. If this parameter is omitted, the default…"}},{"name":"alternate_admins_only","in":"query","required":false,"description":"When **true,** returns only alternate administrators. These users are not administrators but will be set as such if all administrator…","schema":{"type":"string","description":"When **true,** returns only alternate administrators. These users are not administrators but will be set as such if all administrator…"}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Valid values: `1` to `100`"}},{"name":"domain_users_only","in":"query","required":false,"description":"When **true,** return only users in…","schema":{"type":"string","description":"When **true,** return only users in…"}},{"name":"email","in":"query","required":false,"description":"Filters results based on the email address associated with the user that you want to return. **Note:** You can use either this parameter…","schema":{"type":"string","description":"Filters results based on the email address associated with the user that you want to return. **Note:** You can use either this parameter…"}},{"name":"email_substring","in":"query","required":false,"description":"Filters results based on a fragment of an email address. For example, you could enter `gmail.com` to return all users who have Gmail…","schema":{"type":"string","description":"Filters results based on a fragment of an email address. For example, you could enter `gmail.com` to return all users who have Gmail…"}},{"name":"group_id","in":"query","required":false,"description":"Filters results based on one or more group IDs.","schema":{"type":"string","description":"Filters results based on one or more group IDs."}},{"name":"include_license","in":"query","required":false,"schema":{"type":"string"}},{"name":"include_usersettings_for_csv","in":"query","required":false,"description":"When **true,** the response includes the `userSettings` object data in CSV format.","schema":{"type":"string","description":"When **true,** the response includes the `userSettings` object data in CSV format."}},{"name":"login_status","in":"query","required":false,"description":"When **true,** the response includes the login status of each user.","schema":{"type":"string","description":"When **true,** the response includes the login status of each user."}},{"name":"not_group_id","in":"query","required":false,"description":"Return user records excluding the specified group IDs.","schema":{"type":"string","description":"Return user records excluding the specified group IDs."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"status","in":"query","required":false,"description":"Filters results by user account status. A comma-separated list of any of the following: * `ActivationRequired` * `ActivationSent` *…","schema":{"type":"string","description":"Filters results by user account status. A comma-separated list of any of the following: * `ActivationRequired` * `ActivationSent` *…"}},{"name":"user_name_substring","in":"query","required":false,"description":"Filters the user records returned by the user name or a sub-string of user name.","schema":{"type":"string","description":"Filters the user records returned by the user name or a sub-string of user name."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/users-post-users":{"post":{"operationId":"ecommerce_docusign_users_post_users","summary":"Adds new users to the specified account.","description":"POST /v2.1/accounts/{accountId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/users-put-users":{"post":{"operationId":"ecommerce_docusign_users_put_users","summary":"Changes one or more users in the specified account.","description":"PUT /v2.1/accounts/{accountId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"allow_all_languages":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/users-delete-users":{"post":{"operationId":"ecommerce_docusign_users_delete_users","summary":"Closes one or more users in the account.","description":"DELETE /v2.1/accounts/{accountId}/users","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"delete":{"type":"string","description":"A list of groups to remove the user from. A comma-separated list of the following: - `Groups` - `PermissionSet` - `SigningGroupsEmail`"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-get-user":{"get":{"operationId":"ecommerce_docusign_user_get_user","summary":"Gets the user information for a specified user using a userId (GUID). To find a user based on their email…","description":"GET /v2.1/accounts/{accountId}/users/{userId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"additional_info","in":"query","required":false,"description":"Setting this parameter has no effect in this operation.","schema":{"type":"string","description":"Setting this parameter has no effect in this operation."}},{"name":"email","in":"query","required":false,"description":"Setting this parameter has no effect in this operation.","schema":{"type":"string","description":"Setting this parameter has no effect in this operation."}},{"name":"include_license","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-put-user":{"post":{"operationId":"ecommerce_docusign_user_put_user","summary":"Updates user information for the specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"allow_all_languages":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorization-create-user-authorization":{"post":{"operationId":"ecommerce_docusign_user_authorization_create_user_authorization","summary":"Creates a user authorization.","description":"POST /v2.1/accounts/{accountId}/users/{userId}/authorization","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the principal user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorization-get-user-authorization":{"get":{"operationId":"ecommerce_docusign_user_authorization_get_user_authorization","summary":"Returns the user authorization for a given authorization ID.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"authorizationId","in":"query","required":true,"description":"The ID of the user authorization.","schema":{"type":"string","description":"The ID of the user authorization."}},{"name":"userId","in":"query","required":true,"description":"The ID of the principal user.","schema":{"type":"string","description":"The ID of the principal user."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorization-update-user-authorization":{"post":{"operationId":"ecommerce_docusign_user_authorization_update_user_authorization","summary":"Updates the start or end date for a user authorization.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","authorizationId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"authorizationId":{"type":"string","description":"The ID of the user authorization."},"userId":{"type":"string","description":"The ID of the principal user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorization-delete-user-authorization":{"post":{"operationId":"ecommerce_docusign_user_authorization_delete_user_authorization","summary":"Deletes the user authorization.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","authorizationId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"authorizationId":{"type":"string","description":"The ID of the user authorization."},"userId":{"type":"string","description":"The ID of the principal user."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorizations-get-principal-user-authorizations":{"get":{"operationId":"ecommerce_docusign_user_authorizations_get_principal_user_authorizations","summary":"Returns the authorizations for which the specified user is the principal user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/authorizations","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the principal user.","schema":{"type":"string","description":"The ID of the principal user."}},{"name":"active_only","in":"query","required":false,"description":"When **true,** return only active authorizations. The default value is **true.**","schema":{"type":"string","description":"When **true,** return only active authorizations. The default value is **true.**"}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"email_substring","in":"query","required":false,"description":"Filters returned user records by full email address or a substring of email address.","schema":{"type":"string","description":"Filters returned user records by full email address or a substring of email address."}},{"name":"include_closed_users","in":"query","required":false,"description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when…","schema":{"type":"string","description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when…"}},{"name":"permissions","in":"query","required":false,"description":"Filters results by authorization permission. Valid values: * `Send` * `Manage` * `Sign`","schema":{"type":"string","description":"Filters results by authorization permission. Valid values: * `Send` * `Manage` * `Sign`"}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}},{"name":"task_source","in":"query","required":false,"schema":{"type":"string"}},{"name":"task_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","required":false,"description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character.","schema":{"type":"string","description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorizations-post-user-authorizations":{"post":{"operationId":"ecommerce_docusign_user_authorizations_post_user_authorizations","summary":"Create or update multiple user authorizations.","description":"POST /v2.1/accounts/{accountId}/users/{userId}/authorizations","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the principal user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-authorizations-delete-user-authorizations":{"post":{"operationId":"ecommerce_docusign_user_authorizations_delete_user_authorizations","summary":"Delete multiple user authorizations.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/authorizations","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the principal user."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-agent-authorizations-get-agent-user-authorizations":{"get":{"operationId":"ecommerce_docusign_user_agent_authorizations_get_agent_user_authorizations","summary":"Returns the authorizations for which the specified user is the agent user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/authorizations/agent","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The user who is acting as the agent.","schema":{"type":"string","description":"The user who is acting as the agent."}},{"name":"active_only","in":"query","required":false,"description":"When **true,** only active users are returned. The default value is **false.**","schema":{"type":"string","description":"When **true,** only active users are returned. The default value is **false.**"}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return.","schema":{"type":"string","description":"The maximum number of results to return."}},{"name":"email_substring","in":"query","required":false,"description":"Filters returned user records by full email address or a substring of email address.","schema":{"type":"string","description":"Filters returned user records by full email address or a substring of email address."}},{"name":"include_closed_users","in":"query","required":false,"description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when…","schema":{"type":"string","description":"When **true,** returns active and scheduled authorizations of closed users. The default value is **true.** This value is only applied when…"}},{"name":"permissions","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","required":false,"description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.","schema":{"type":"string","description":"The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image."}},{"name":"task_source","in":"query","required":false,"schema":{"type":"string"}},{"name":"task_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"user_name_substring","in":"query","required":false,"description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character.","schema":{"type":"string","description":"Filters results based on a full or partial user name. **Note:** When you enter a partial user name, you do not use a wildcard character."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-get-cloud-storage-providers":{"get":{"operationId":"ecommerce_docusign_cloud_storage_get_cloud_storage_providers","summary":"Get the Cloud Storage Provider configuration for the specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"redirectUrl","in":"query","required":false,"description":"The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the…","schema":{"type":"string","description":"The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-post-cloud-storage":{"post":{"operationId":"ecommerce_docusign_cloud_storage_post_cloud_storage","summary":"Configures the redirect URL information for one or more cloud storage providers for the specified user.","description":"POST /v2.1/accounts/{accountId}/users/{userId}/cloud_storage","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-delete-cloud-storage-providers":{"post":{"operationId":"ecommerce_docusign_cloud_storage_delete_cloud_storage_providers","summary":"Deletes the user authentication information for one or more cloud storage providers.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-get-cloud-storage":{"get":{"operationId":"ecommerce_docusign_cloud_storage_get_cloud_storage","summary":"Gets the specified Cloud Storage Provider configuration for the User.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"serviceId","in":"query","required":true,"description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","schema":{"type":"string","description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"redirectUrl","in":"query","required":false,"description":"The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the…","schema":{"type":"string","description":"The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-delete-cloud-storage":{"post":{"operationId":"ecommerce_docusign_cloud_storage_delete_cloud_storage","summary":"Deletes the user authentication information for the specified cloud storage provider.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","serviceId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"serviceId":{"type":"string","description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-folder-get-cloud-storage-folder-all":{"get":{"operationId":"ecommerce_docusign_cloud_storage_folder_get_cloud_storage_folder_all","summary":"Retrieves a list of all the items in a specified folder from the specified cloud storage provider.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"serviceId","in":"query","required":true,"description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","schema":{"type":"string","description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"cloud_storage_folder_path","in":"query","required":false,"description":"A comma separated list of folder IDs included in the request.","schema":{"type":"string","description":"A comma separated list of folder IDs included in the request."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`"}},{"name":"order","in":"query","required":false,"description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.","schema":{"type":"string","description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order."}},{"name":"order_by","in":"query","required":false,"description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`","schema":{"type":"string","description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`"}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/cloud-storage-folder-get-cloud-storage-folder":{"get":{"operationId":"ecommerce_docusign_cloud_storage_folder_get_cloud_storage_folder","summary":"Gets a list of items from a cloud storage provider.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"folderId","in":"query","required":true,"description":"The ID of the folder.","schema":{"type":"string","description":"The ID of the folder."}},{"name":"serviceId","in":"query","required":true,"description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\").","schema":{"type":"string","description":"The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"cloud_storage_folder_path","in":"query","required":false,"description":"The file path to a cloud storage folder.","schema":{"type":"string","description":"The file path to a cloud storage folder."}},{"name":"cloud_storage_folderid_plain","in":"query","required":false,"description":"A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter…","schema":{"type":"string","description":"A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter…"}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip. Default: `25`"}},{"name":"order","in":"query","required":false,"description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.","schema":{"type":"string","description":"The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order."}},{"name":"order_by","in":"query","required":false,"description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`","schema":{"type":"string","description":"The file attribute to use to sort the results. Valid values are: * `modified` * `name`"}},{"name":"search_text","in":"query","required":false,"description":"Use this parameter to search for specific text.","schema":{"type":"string","description":"Use this parameter to search for specific text."}},{"name":"sky_drive_skip_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-custom-settings-get-custom-settings":{"get":{"operationId":"ecommerce_docusign_user_custom_settings_get_custom_settings","summary":"Retrieves the custom user settings for a specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/custom_settings","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-custom-settings-put-custom-settings":{"post":{"operationId":"ecommerce_docusign_user_custom_settings_put_custom_settings","summary":"Adds or updates custom user settings for the specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/custom_settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-custom-settings-delete-custom-settings":{"post":{"operationId":"ecommerce_docusign_user_custom_settings_delete_custom_settings","summary":"Deletes custom user settings for a specified user.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/custom_settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-profile-get-profile":{"get":{"operationId":"ecommerce_docusign_user_profile_get_profile","summary":"Retrieves the user profile for a specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/profile","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-profile-put-profile":{"post":{"operationId":"ecommerce_docusign_user_profile_put_profile","summary":"Updates the user profile information for the specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/profile","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-profile-image-get-user-profile-image":{"get":{"operationId":"ecommerce_docusign_user_profile_image_get_user_profile_image","summary":"Retrieves the user profile image for the specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/profile/image","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"encoding","in":"query","required":false,"description":"Reserved for Docusign.","schema":{"type":"string","description":"Reserved for Docusign."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-profile-image-put-user-profile-image":{"post":{"operationId":"ecommerce_docusign_user_profile_image_put_user_profile_image","summary":"Updates the user profile image for a specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/profile/image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-profile-image-delete-user-profile-image":{"post":{"operationId":"ecommerce_docusign_user_profile_image_delete_user_profile_image","summary":"Deletes the user profile image for the specified user.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/profile/image","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-settings-get-user-settings":{"get":{"operationId":"ecommerce_docusign_user_settings_get_user_settings","summary":"Gets the user account settings for a specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/settings","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-settings-put-user-settings":{"post":{"operationId":"ecommerce_docusign_user_settings_put_user_settings","summary":"Updates the user account settings for a specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/settings","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"allow_all_languages":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-get-user-signatures":{"get":{"operationId":"ecommerce_docusign_user_signatures_get_user_signatures","summary":"Retrieves a list of signature definitions for a user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/signatures","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"stamp_type","in":"query","required":false,"description":"The type of stamps to return. Valid values are: - `signature`: Returns information about signature images only. This is the default value.…","schema":{"type":"string","description":"The type of stamps to return. Valid values are: - `signature`: Returns information about signature images only. This is the default value.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-post-user-signatures":{"post":{"operationId":"ecommerce_docusign_user_signatures_post_user_signatures","summary":"Adds user Signature and initials images to a Signature.","description":"POST /v2.1/accounts/{accountId}/users/{userId}/signatures","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-put-user-signature":{"post":{"operationId":"ecommerce_docusign_user_signatures_put_user_signature","summary":"Adds/updates a user signature.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/signatures","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-get-user-signature":{"get":{"operationId":"ecommerce_docusign_user_signatures_get_user_signature","summary":"Gets the user signature information for the specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"signatureId","in":"query","required":true,"description":"The ID of the account stamp.","schema":{"type":"string","description":"The ID of the account stamp."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-put-user-signature-by-id":{"post":{"operationId":"ecommerce_docusign_user_signatures_put_user_signature_by_id","summary":"Updates the user signature for a specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signatureId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signatureId":{"type":"string","description":"The ID of the account stamp."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"close_existing_signature":{"type":"string","description":"When **true,** closes the current signature."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-delete-user-signature":{"post":{"operationId":"ecommerce_docusign_user_signatures_delete_user_signature","summary":"Removes removes signature information for the specified user.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","signatureId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"signatureId":{"type":"string","description":"The ID of the account stamp."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-get-user-signature-image":{"get":{"operationId":"ecommerce_docusign_user_signatures_get_user_signature_image","summary":"Retrieves the user initials image or the user signature image for the specified user.","description":"GET /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"imageType","in":"query","required":true,"description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`","schema":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"}},{"name":"signatureId","in":"query","required":true,"description":"The ID of the account stamp.","schema":{"type":"string","description":"The ID of the account stamp."}},{"name":"userId","in":"query","required":true,"description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…","schema":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}},{"name":"include_chrome","in":"query","required":false,"description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image.","schema":{"type":"string","description":"When **true,** the chrome (or frame containing the added line and identifier) is included with the signature image."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-put-user-signature-image":{"post":{"operationId":"ecommerce_docusign_user_signatures_put_user_signature_image","summary":"Updates the user signature image or user initials image for the specified user.","description":"PUT /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","imageType","signatureId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"},"signatureId":{"type":"string","description":"The ID of the account stamp."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"},"transparent_png":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/user-signatures-delete-user-signature-image":{"post":{"operationId":"ecommerce_docusign_user_signatures_delete_user_signature_image","summary":"Deletes the user initials image or the user signature image for the specified user.","description":"DELETE /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","imageType","signatureId","userId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"imageType":{"type":"string","description":"Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image`"},"signatureId":{"type":"string","description":"The ID of the account stamp."},"userId":{"type":"string","description":"The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/views-post-account-console-view":{"post":{"operationId":"ecommerce_docusign_views_post_account_console_view","summary":"Returns a URL to the Docusign eSignature web application.","description":"POST /v2.1/accounts/{accountId}/views/console","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/watermark-get-watermark":{"get":{"operationId":"ecommerce_docusign_watermark_get_watermark","summary":"Get watermark information.","description":"GET /v2.1/accounts/{accountId}/watermark","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/watermark-put-watermark":{"post":{"operationId":"ecommerce_docusign_watermark_put_watermark","summary":"Update watermark information.","description":"PUT /v2.1/accounts/{accountId}/watermark","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/watermark-preview-put-watermark-preview":{"post":{"operationId":"ecommerce_docusign_watermark_preview_put_watermark_preview","summary":"Get watermark preview.","description":"PUT /v2.1/accounts/{accountId}/watermark/preview","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-get-workspaces":{"get":{"operationId":"ecommerce_docusign_workspace_get_workspaces","summary":"List Workspaces","description":"GET /v2.1/accounts/{accountId}/workspaces","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-post-workspace":{"post":{"operationId":"ecommerce_docusign_workspace_post_workspace","summary":"Create a Workspace","description":"POST /v2.1/accounts/{accountId}/workspaces","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-get-workspace":{"get":{"operationId":"ecommerce_docusign_workspace_get_workspace","summary":"Get Workspace","description":"GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"workspaceId","in":"query","required":true,"description":"The ID of the workspace.","schema":{"type":"string","description":"The ID of the workspace."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-put-workspace":{"post":{"operationId":"ecommerce_docusign_workspace_put_workspace","summary":"Update Workspace","description":"PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","workspaceId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"workspaceId":{"type":"string","description":"The ID of the workspace."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-delete-workspace":{"post":{"operationId":"ecommerce_docusign_workspace_delete_workspace","summary":"Delete Workspace","description":"DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","workspaceId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"workspaceId":{"type":"string","description":"The ID of the workspace."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-folder-get-workspace-folder":{"get":{"operationId":"ecommerce_docusign_workspace_folder_get_workspace_folder","summary":"List workspace folder contents","description":"GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"folderId","in":"query","required":true,"description":"The ID of the folder.","schema":{"type":"string","description":"The ID of the folder."}},{"name":"workspaceId","in":"query","required":true,"description":"The ID of the workspace.","schema":{"type":"string","description":"The ID of the workspace."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."}},{"name":"include_files","in":"query","required":false,"description":"When **true,** the response includes file information (in addition to folder information). The default is **false.**","schema":{"type":"string","description":"When **true,** the response includes file information (in addition to folder information). The default is **false.**"}},{"name":"include_sub_folders","in":"query","required":false,"description":"When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**","schema":{"type":"string","description":"When **true,** the response includes information about the sub-folders of the current folder. The default is **false.**"}},{"name":"include_thumbnails","in":"query","required":false,"description":"When **true,** the response returns thumbnails. The default is **false.**","schema":{"type":"string","description":"When **true,** the response returns thumbnails. The default is **false.**"}},{"name":"include_user_detail","in":"query","required":false,"description":"When **true,** the response includes extended details about the user. The default is **false.**","schema":{"type":"string","description":"When **true,** the response includes extended details about the user. The default is **false.**"}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}},{"name":"workspace_user_id","in":"query","required":false,"description":"If set, the response only includes results associated with the `userId` that you specify.","schema":{"type":"string","description":"If set, the response only includes results associated with the `userId` that you specify."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-folder-delete-workspace-items":{"post":{"operationId":"ecommerce_docusign_workspace_folder_delete_workspace_items","summary":"Deletes files or sub-folders from a workspace.","description":"DELETE /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","folderId","workspaceId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"folderId":{"type":"string","description":"The ID of the folder."},"workspaceId":{"type":"string","description":"The ID of the workspace."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-file-post-workspace-files":{"post":{"operationId":"ecommerce_docusign_workspace_file_post_workspace_files","summary":"Creates a workspace file.","description":"POST /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","folderId","workspaceId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"folderId":{"type":"string","description":"The ID of the folder."},"workspaceId":{"type":"string","description":"The ID of the workspace."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-file-get-workspace-file":{"get":{"operationId":"ecommerce_docusign_workspace_file_get_workspace_file","summary":"Gets a workspace file","description":"GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"fileId","in":"query","required":true,"description":"The ID of the file.","schema":{"type":"string","description":"The ID of the file."}},{"name":"folderId","in":"query","required":true,"description":"The ID of the folder.","schema":{"type":"string","description":"The ID of the folder."}},{"name":"workspaceId","in":"query","required":true,"description":"The ID of the workspace.","schema":{"type":"string","description":"The ID of the workspace."}},{"name":"is_download","in":"query","required":false,"description":"When **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The…","schema":{"type":"string","description":"When **true,** the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The…"}},{"name":"pdf_version","in":"query","required":false,"description":"When **true** the file is returned in PDF format.","schema":{"type":"string","description":"When **true** the file is returned in PDF format."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-file-put-workspace-file":{"post":{"operationId":"ecommerce_docusign_workspace_file_put_workspace_file","summary":"Update workspace file or folder metadata","description":"PUT /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","fileId","folderId","workspaceId"],"properties":{"accountId":{"type":"string","description":"The external account number (int) or account ID GUID."},"fileId":{"type":"string","description":"The ID of the file."},"folderId":{"type":"string","description":"The ID of the folder."},"workspaceId":{"type":"string","description":"The ID of the workspace."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/workspace-file-pages-get-workspace-file-pages":{"get":{"operationId":"ecommerce_docusign_workspace_file_pages_get_workspace_file_pages","summary":"List File Pages","description":"GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages","tags":["ecommerce"],"parameters":[{"name":"accountId","in":"query","required":true,"description":"The external account number (int) or account ID GUID.","schema":{"type":"string","description":"The external account number (int) or account ID GUID."}},{"name":"fileId","in":"query","required":true,"description":"The ID of the file.","schema":{"type":"string","description":"The ID of the file."}},{"name":"folderId","in":"query","required":true,"description":"The ID of the folder.","schema":{"type":"string","description":"The ID of the folder."}},{"name":"workspaceId","in":"query","required":true,"description":"The ID of the workspace.","schema":{"type":"string","description":"The ID of the workspace."}},{"name":"count","in":"query","required":false,"description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip.","schema":{"type":"string","description":"The maximum number of results to return. Use `start_position` to specify the number of results to skip."}},{"name":"dpi","in":"query","required":false,"description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.","schema":{"type":"string","description":"The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94."}},{"name":"max_height","in":"query","required":false,"description":"Sets the maximum height of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum height of the returned images in pixels."}},{"name":"max_width","in":"query","required":false,"description":"Sets the maximum width of the returned images in pixels.","schema":{"type":"string","description":"Sets the maximum width of the returned images in pixels."}},{"name":"start_position","in":"query","required":false,"description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…","schema":{"type":"string","description":"The zero-based index of the result from which to start returning results. Use with `count` to limit the number of results. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/accounts-get-provisioning":{"get":{"operationId":"ecommerce_docusign_accounts_get_provisioning","summary":"Retrieves the account provisioning information for the account.","description":"GET /v2.1/accounts/provisioning","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plans-get-billing-plans":{"get":{"operationId":"ecommerce_docusign_billing_plans_get_billing_plans","summary":"Gets a list of available billing plans.","description":"GET /v2.1/billing_plans","tags":["ecommerce"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/billing-plans-get-billing-plan":{"get":{"operationId":"ecommerce_docusign_billing_plans_get_billing_plan","summary":"Gets billing plan details.","description":"GET /v2.1/billing_plans/{billingPlanId}","tags":["ecommerce"],"parameters":[{"name":"billingPlanId","in":"query","required":true,"description":"The ID of the billing plan being accessed.","schema":{"type":"string","description":"The ID of the billing plan being accessed."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:docusign/notary-get-notary":{"get":{"operationId":"ecommerce_docusign_notary_get_notary","summary":"Gets settings for a notary user.","description":"GET /v2.1/current_user/notary","tags":["ecommerce"],"parameters":[{"name":"include_jurisdictions","in":"query","required":false,"description":"When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current…","schema":{"type":"string","description":"When **true,** the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}