DocuSign: Creates a new account settings import request
DocuSign admin.adminOrganizationImportOrganizationImportAccountSettingsPost: arguments, response, policy and SDK examples.
← Admin operations · Get started
Operation docusign.admin_organizationimport_organizationimportaccountsettings_post
Provider route: POST /Management/v2/organizations/{organizationId}/imports/account_settings. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminOrganizationImportOrganizationImportAccountSettingsPost"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.admin.adminOrganizationImportOrganizationImportAccountSettingsPost(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.admin.admin_organization_import_organization_import_account_settings_post(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
body | object | Required within parent | |
body.file.csv | object | Required within parent | CSV file. Additional keys: not allowed |
body.file.csv.filename | string | Required within parent | Minimum length: 1 |
body.file.csv.content_type | string | Required within parent | Minimum length: 1 |
body.file.csv.content_base64 | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Creates a new account settings import request — response body |
Referenced models: Creates a new account settings import request — response body
Schemas
Section titled “Schemas”Creates a new account settings import request — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
completed | string | Optional | Format: date-time |
created | string | Optional | Format: date-time |
expires | string | Optional | Format: date-time |
id | string | Optional | |
last_modified | string | Optional | Format: date-time |
number_processed_accounts | JSON | Optional | |
number_processed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_processed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_unprocessed_accounts | JSON | Optional | |
number_unprocessed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_unprocessed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
organization_id | string | Optional | |
percent_completed | JSON | Optional | |
percent_completed (anyOf 1) | integer | Alternative | Format: int32 |
percent_completed (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
requestor | Model | Optional | Expand Creates a new account settings import request — response body — requestor |
results | array | Optional | |
results[] | Model | Each item | Expand Creates a new account settings import request — response body — results item |
skipped_settings_by_account | object | Optional | Additional keys: see wildcard field |
skipped_settings_by_account.* | array | Additional keys | |
skipped_settings_by_account.*[] | string | Each item | |
status | string | Optional | Status. |
success | boolean | Optional | |
type | string | Optional |
Referenced models: Creates a new account settings import request — response body — requestor, Creates a new account settings import request — response body — results item
Creates a new account settings import request — response body — requestor
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address. |
id | string | Optional | |
name | string | Optional | |
type | string | Optional |
Creates a new account settings import request — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_details | Model | Optional | Expand Creates a user list export request — response body — results item error details Error results. |
id | string | Optional | Format: uuid |
number_processed_accounts | JSON | Optional | |
number_processed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_processed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_unprocessed_accounts | JSON | Optional | |
number_unprocessed_accounts (anyOf 1) | integer | Alternative | Format: int64 |
number_unprocessed_accounts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
processing_issues_by_account | array | Optional | |
processing_issues_by_account[] | Model | Each item | Expand Creates a new account settings import request — response body — results item processing issues by account item |
site_id | JSON | Optional | |
site_id (anyOf 1) | integer | Alternative | Format: int32 |
site_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Optional |
Referenced models: Creates a user list export request — response body — results item error details, Creates a new account settings import request — response body — results item processing issues by account item
Creates a user list export request — response body — results item error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | string | Optional | The error number. |
error_description | string | Optional | A longer description of the error. |
Creates a new account settings import request — response body — results item processing issues by account item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_id | string | Optional | Select users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified. |
account_name | string | Optional | |
error | string | Optional | The error number. |
error_key | string | Optional | |
setting_key | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.admin_organizationimport_organizationimportaccountsettings_post. Catalog operation: admin:OrganizationImport_OrganizationImportAccountSettings_Post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["account_write"]