Create account settings import request

POST

/v2/organizations/:organizationId/imports/account_settings

POST

/Management/v2/organizations/:organizationId/imports/account_settings

curl -X POST https://api-d.docusign.net/Management/v2/organizations/organizationId/imports/account_settings \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file.csv=@string

200Successful

{
  "created": "2024-01-15T09:30:00Z",
  "last_modified": "2024-01-15T09:30:00Z",
  "completed": "2024-01-15T09:30:00Z",
  "expires": "2024-01-15T09:30:00Z",
  "percent_completed": 1,
  "number_processed_accounts": 1,
  "number_unprocessed_accounts": 1,
  "results": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "site_id": 1,
      "url": "string",
      "number_processed_accounts": 1,
      "error_details": {
        "error": "string",
        "error_description": "string"
      },
      "processing_issues_by_account": [
        {
          "account_id": "string",
          "account_name": "string",
          "error": "string",
          "error_key": "string",
          "setting_key": "string"
        }
      ],
      "number_unprocessed_accounts": 1
    }
  ],
  "success": true,
  "skipped_settings_by_account": {},
  "id": "string",
  "organization_id": "string",
  "status": "string",
  "type": "string",
  "requestor": {
    "id": "string",
    "type": "string",
    "name": "string",
    "email": "string"
  }
}

Creates a new account settings import request.

The request for this method consists of the contents of a CSV file.

You can export your current settings as a CSV file with AccountSettingsExport: createAccountSettingsExport and use it as the basis of the changes you want to import.

To learn more about the format of a settings CSV file, see Preparing a CSV for account settings import in the Docusign Admin Guide.

You can import settings for up to 40 accounts at a time.

Required authentication scopes: account_write.

Account Settings import guide
Account Settings Export guide

Authentication

AuthorizationBearer

OAuth2 Access code Grant

Path parameters

organizationIdstringRequiredformat: "uuid"

The organization ID Guid

Request

This endpoint expects a multipart form containing a file.

file.csvfileRequired

CSV file.

Response

createddatetimeOptional

last_modifieddatetimeOptional

completeddatetimeOptional

expiresdatetimeOptional

percent_completedintegerOptional

number_processed_accountslongOptional

number_unprocessed_accountslongOptional

resultslist of objectsOptional

successbooleanOptional

skipped_settings_by_accountmap from strings to lists of stringsOptional

idstringOptional

organization_idstringOptional

statusstringOptional

Status.

typestringOptional

requestorobjectOptional

Related topics

Authentication

Path parameters

Request

Response