Creates new accounts
Creates new Docusign accounts. You can use this method to create a single account or up to 100 accounts at a time.
Note: This method is restricted to partner integrations. You must work with Docusign Professional Services or Docusign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body.
When creating a single account,
the body of the request is a
newAccountRequest
object.
Example:
{ "newAccountRequest": [ { "accountName":"Test Account", "distributorCode":"MY_DIST_CODE", "distributorPassword":"MY_DIST_PWD", "initialUser":{ "email":"user@emaildomain.com", "firstName":"John", "middleName": "Harry", "lastName":"Doe", "suffixName": "", "userName": "John Doe", "jobTitle": "Engineer", "company": "Test Company" }, "addressInformation":{ "address1": "1234 Main Street", "address2": "Suite 100", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US", "phone": "1234567890", "fax": "1234567891" }, "planInformation":{ "planId":"37085696-xxxx-xxxx-xxxx-7ea067752959" }, "referralInformation":{ "includedSeats": "1", "referralCode": "code", "referrerName": "name" } } ]}If the request succeeds, it returns a 201 (Created) HTTP response code. The response returns the new account ID, password, and the default user information for each newly created account.
When creating multiple accounts,
the body of the request is a
newAccountRequests
object,
which contains one or more
newAccountDefinition
objects.
You can create up to 100 new accounts
at a time this way.
The body for a multi-account creation request looks like this in JSON:
{ "newAccountRequests": [ { "accountName": "accountone", . . . }, { "accountName": "accounttwo", . . . } ]}A multi-account request looks like this in XML:
<newAccountsDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi"> <newAccountRequests> <newAccountDefinition> . . . </newAccountDefinition> <newAccountDefinition> . . . </newAccountDefinition> </newAccountRequests></newAccountsDefinition>A multi-account creation request
may succeed (report a 201 code)
even if some accounts could not be created.
In this case, the errorDetails property
in the response contains specific information
about the failure.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Request Body
application/json
The account name for the new account.
Contains account settings information. Used in requests to set property values. Used in responses to report property values.
Contains information about the address associated with the account.
This object contains information about a credit card that is associated with an account.
Contains information about a bank that processes a customer's direct debit payments.
The Distributor Code that you received from Docusign.
The password for the distributorCode.
Reserved for Docusign.
User information.
The payment method used for the billing plan. Valid values are:
NotSupportedCreditCardPurchaseOrderPremiumFreemiumFreeTrialAppStoreDigitalExternalDirectDebit
An object used to identify the features and attributes of the account being created.
A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry
Note: saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for Docusign use only.
Response Body
application/json
application/json
curl -X POST "https://example.com/v2.1/accounts" \ -H "Content-Type: application/json" \ -d '{}'{ "accountId": "string", "accountIdGuid": "string", "accountName": "string", "apiPassword": "string", "baseUrl": "string", "billingPlanPreview": { "currencyCode": "string", "invoice": { "amount": "string", "balance": "string", "dueDate": "string", "invoiceId": "string", "invoiceItems": [ { "chargeAmount": "string", "chargeName": "string", "invoiceItemId": "string", "quantity": "string", "taxAmount": "string", "taxExemptAmount": "string", "unitPrice": "string" } ], "invoiceNumber": "string", "invoiceUri": "string", "nonTaxableAmount": "string", "pdfAvailable": "string", "taxableAmount": "string" }, "isProrated": "string", "subtotalAmount": "string", "taxAmount": "string", "totalAmount": "string" }, "userId": "string"}