Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "accountName": "sample string 1",
* "distributorCode": "sample string 2",
* "distributorPassword": "sample string 3",
* "planInformation": {
* "planId": "sample string 1",
* "planFeatureSets": [
* {
* "featureSetId": "sample string 1",
* "isActive": "sample string 2",
* "name": "sample string 3",
* "fixedFee": "sample string 4",
* "envelopeFee": "sample string 5",
* "seatFee": "sample string 6",
* "isEnabled": "sample string 7",
* "is21CFRPart11": "sample string 8",
* "currencyFeatureSetPrices": [
* {
* "currencyCode": "sample string 1",
* "fixedFee": "sample string 2",
* "seatFee": "sample string 3",
* "envelopeFee": "sample string 4",
* "currencySymbol": "sample string 5"
* }
* ]
* }
* ],
* "addOns": [
* {
* "id": "sample string 1",
* "addOnId": "sample string 2",
* "name": "sample string 3",
* "active": "sample string 4"
* }
* ],
* "recipientDomains": [
* {
* "recipientDomainId": "sample string 1",
* "domainCode": "sample string 2",
* "domainName": "sample string 3",
* "active": "sample string 4"
* }
* ],
* "currencyCode": "sample string 2",
* "freeTrialDaysOverride": "sample string 3"
* },
* "creditCardInformation": {
* "cardNumber": "sample string 1",
* "expirationMonth": "sample string 2",
* "expirationYear": "sample string 3",
* "nameOnCard": "sample string 4",
* "cardType": "sample string 5",
* "address": {
* "street1": "sample string 1",
* "street2": "sample string 2",
* "city": "sample string 3",
* "state": "sample string 4",
* "zip": "sample string 5",
* "phone": "sample string 6",
* "fax": "sample string 7",
* "country": "sample string 8",
* "zipPlus4": "sample string 9"
* }
* },
* "referralInformation": {
* "enableSupport": "sample string 1",
* "includedSeats": "sample string 2",
* "saleDiscountPercent": "sample string 3",
* "saleDiscountAmount": "sample string 4",
* "saleDiscountFixedAmount": "sample string 5",
* "saleDiscountPeriods": "sample string 6",
* "saleDiscountSeatPriceOverride": "sample string 7",
* "planStartMonth": "sample string 8",
* "referralCode": "sample string 9",
* "referrerName": "sample string 10",
* "advertisementId": "sample string 11",
* "publisherId": "sample string 12",
* "shopperId": "sample string 13",
* "promoCode": "sample string 14",
* "groupMemberId": "sample string 15",
* "idType": "sample string 16",
* "industry": "sample string 17",
* "externalOrgId": "sample string 18"
* },
* "accountSettings": [
* {}
* ],
* "initialUser": {
* "userName": "sample string 1",
* "userId": "sample string 2",
* "userType": "sample string 3",
* "isAdmin": "sample string 4",
* "userStatus": "sample string 5",
* "uri": "sample string 6",
* "email": "sample string 7",
* "password": "sample string 8",
* "title": "sample string 9",
* "createdDateTime": "sample string 10",
* "firstName": "sample string 11",
* "middleName": "sample string 12",
* "lastName": "sample string 13",
* "suffixName": "sample string 14",
* "permissionProfileId": "sample string 15",
* "permissionProfileName": "sample string 16",
* "countryCode": "sample string 17",
* "subscribe": "sample string 18",
* "userSettings": [
* {}
* ],
* "accountManagementGranular": {
* "canManageUsers": "sample string 1",
* "canManageAdmins": "sample string 2",
* "canManageGroups": "sample string 3",
* "canManageSharing": "sample string 4",
* "canManageEnvelopeTransfer": "sample string 5",
* "canManageAccountSettings": "sample string 6",
* "canManageReporting": "sample string 7",
* "canManageAccountSecuritySettings": "sample string 8",
* "canManageSigningGroups": "sample string 9",
* "canManageDocumentRetention": "sample string 10",
* "canViewUsers": "sample string 11",
* "canManageUsersMetadata": {
* "rights": "sample string 1",
* "uiHint": "sample string 2",
* "uiType": "sample string 3",
* "uiOrder": "sample string 4",
* "is21CFRPart11": "sample string 5",
* "options": [
* "sample string 1"
* ]
* },
* "canManageAdminsMetadata": {},
* "canManageGroupsMetadata": {},
* "canManageSharingMetadata": {},
* "canManageEnvelopeTransferMetadata": {},
* "canManageAccountSettingsMetadata": {},
* "canManageReportingMetadata": {},
* "canManageAccountSecuritySettingsMetadata": {},
* "canManageSigningGroupsMetadata": {},
* "canManageDocumentRetentionMetadata": {},
* "canViewUsersMetadata": {}
* },
* "sendActivationOnInvalidLogin": "sample string 19",
* "activationAccessCode": "sample string 20",
* "enableConnectForUser": "sample string 21",
* "forgottenPasswordInfo": {
* "forgottenPasswordQuestion1": "sample string 1",
* "forgottenPasswordAnswer1": "sample string 2",
* "forgottenPasswordQuestion2": "sample string 3",
* "forgottenPasswordAnswer2": "sample string 4",
* "forgottenPasswordQuestion3": "sample string 5",
* "forgottenPasswordAnswer3": "sample string 6",
* "forgottenPasswordQuestion4": "sample string 7",
* "forgottenPasswordAnswer4": "sample string 8"
* },
* "groupList": [
* {
* "groupId": "sample string 1",
* "groupName": "sample string 2",
* "permissionProfileId": "sample string 3",
* "groupType": "sample string 4",
* "users": [
* {
* "userName": "sample string 1",
* "userId": "sample string 2",
* "email": "sample string 3",
* "userType": "sample string 4",
* "userStatus": "sample string 5",
* "uri": "sample string 6",
* "loginStatus": "sample string 7",
* "sendActivationEmail": "sample string 8",
* "activationAccessCode": "sample string 9"
* }
* ]
* }
* ],
* "workAddress": {
* "address1": "sample string 1",
* "address2": "sample string 2",
* "city": "sample string 3",
* "stateOrProvince": "sample string 4",
* "postalCode": "sample string 5",
* "phone": "sample string 6",
* "fax": "sample string 7",
* "country": "sample string 8"
* },
* "homeAddress": {},
* "loginStatus": "sample string 22",
* "passwordExpiration": "sample string 23",
* "lastLogin": "sample string 24",
* "sendActivationEmail": "sample string 25",
* "customSettings": [
* {}
* ],
* "profileImageUri": "sample string 26",
* "userProfileLastModifiedDate": "sample string 27",
* "signatureImageUri": "sample string 28",
* "initialsImageUri": "sample string 29",
* "jobTitle": "sample string 30"
* },
* "addressInformation": {
* "address1": "sample string 1",
* "address2": "sample string 2",
* "city": "sample string 3",
* "state": "sample string 4",
* "postalCode": "sample string 5",
* "phone": "sample string 6",
* "fax": "sample string 7",
* "country": "sample string 8",
* "firstName": "sample string 9",
* "lastName": "sample string 10",
* "email": "sample string 11",
* "supportedCountries": [
* {
* "isoCode": "sample string 1",
* "provinceValidated": "sample string 2",
* "name": "sample string 3",
* "provinces": [
* {
* "isoCode": "sample string 1",
* "name": "sample string 2"
* }
* ]
* }
* ]
* },
* "socialAccountInformation": {
* "provider": "sample string 1",
* "email": "sample string 2",
* "socialId": "sample string 3",
* "userName": "sample string 4"
* },
* "PaymentProcessorInformation": {
* "billingAgreementId": "sample string 1",
* "email": "sample string 2",
* "address": {}
* },
* "envelopePartitionId": null
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("accountName","sample string 1")
loJson.UpdateString("distributorCode","sample string 2")
loJson.UpdateString("distributorPassword","sample string 3")
loJson.UpdateString("planInformation.planId","sample string 1")
loJson.UpdateString("planInformation.planFeatureSets[0].featureSetId","sample string 1")
loJson.UpdateString("planInformation.planFeatureSets[0].isActive","sample string 2")
loJson.UpdateString("planInformation.planFeatureSets[0].name","sample string 3")
loJson.UpdateString("planInformation.planFeatureSets[0].fixedFee","sample string 4")
loJson.UpdateString("planInformation.planFeatureSets[0].envelopeFee","sample string 5")
loJson.UpdateString("planInformation.planFeatureSets[0].seatFee","sample string 6")
loJson.UpdateString("planInformation.planFeatureSets[0].isEnabled","sample string 7")
loJson.UpdateString("planInformation.planFeatureSets[0].is21CFRPart11","sample string 8")
loJson.UpdateString("planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].currencyCode","sample string 1")
loJson.UpdateString("planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].fixedFee","sample string 2")
loJson.UpdateString("planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].seatFee","sample string 3")
loJson.UpdateString("planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].envelopeFee","sample string 4")
loJson.UpdateString("planInformation.planFeatureSets[0].currencyFeatureSetPrices[0].currencySymbol","sample string 5")
loJson.UpdateString("planInformation.addOns[0].id","sample string 1")
loJson.UpdateString("planInformation.addOns[0].addOnId","sample string 2")
loJson.UpdateString("planInformation.addOns[0].name","sample string 3")
loJson.UpdateString("planInformation.addOns[0].active","sample string 4")
loJson.UpdateString("planInformation.recipientDomains[0].recipientDomainId","sample string 1")
loJson.UpdateString("planInformation.recipientDomains[0].domainCode","sample string 2")
loJson.UpdateString("planInformation.recipientDomains[0].domainName","sample string 3")
loJson.UpdateString("planInformation.recipientDomains[0].active","sample string 4")
loJson.UpdateString("planInformation.currencyCode","sample string 2")
loJson.UpdateString("planInformation.freeTrialDaysOverride","sample string 3")
loJson.UpdateString("creditCardInformation.cardNumber","sample string 1")
loJson.UpdateString("creditCardInformation.expirationMonth","sample string 2")
loJson.UpdateString("creditCardInformation.expirationYear","sample string 3")
loJson.UpdateString("creditCardInformation.nameOnCard","sample string 4")
loJson.UpdateString("creditCardInformation.cardType","sample string 5")
loJson.UpdateString("creditCardInformation.address.street1","sample string 1")
loJson.UpdateString("creditCardInformation.address.street2","sample string 2")
loJson.UpdateString("creditCardInformation.address.city","sample string 3")
loJson.UpdateString("creditCardInformation.address.state","sample string 4")
loJson.UpdateString("creditCardInformation.address.zip","sample string 5")
loJson.UpdateString("creditCardInformation.address.phone","sample string 6")
loJson.UpdateString("creditCardInformation.address.fax","sample string 7")
loJson.UpdateString("creditCardInformation.address.country","sample string 8")
loJson.UpdateString("creditCardInformation.address.zipPlus4","sample string 9")
loJson.UpdateString("referralInformation.enableSupport","sample string 1")
loJson.UpdateString("referralInformation.includedSeats","sample string 2")
loJson.UpdateString("referralInformation.saleDiscountPercent","sample string 3")
loJson.UpdateString("referralInformation.saleDiscountAmount","sample string 4")
loJson.UpdateString("referralInformation.saleDiscountFixedAmount","sample string 5")
loJson.UpdateString("referralInformation.saleDiscountPeriods","sample string 6")
loJson.UpdateString("referralInformation.saleDiscountSeatPriceOverride","sample string 7")
loJson.UpdateString("referralInformation.planStartMonth","sample string 8")
loJson.UpdateString("referralInformation.referralCode","sample string 9")
loJson.UpdateString("referralInformation.referrerName","sample string 10")
loJson.UpdateString("referralInformation.advertisementId","sample string 11")
loJson.UpdateString("referralInformation.publisherId","sample string 12")
loJson.UpdateString("referralInformation.shopperId","sample string 13")
loJson.UpdateString("referralInformation.promoCode","sample string 14")
loJson.UpdateString("referralInformation.groupMemberId","sample string 15")
loJson.UpdateString("referralInformation.idType","sample string 16")
loJson.UpdateString("referralInformation.industry","sample string 17")
loJson.UpdateString("referralInformation.externalOrgId","sample string 18")
loJson.UpdateString("initialUser.userName","sample string 1")
loJson.UpdateString("initialUser.userId","sample string 2")
loJson.UpdateString("initialUser.userType","sample string 3")
loJson.UpdateString("initialUser.isAdmin","sample string 4")
loJson.UpdateString("initialUser.userStatus","sample string 5")
loJson.UpdateString("initialUser.uri","sample string 6")
loJson.UpdateString("initialUser.email","sample string 7")
loJson.UpdateString("initialUser.password","sample string 8")
loJson.UpdateString("initialUser.title","sample string 9")
loJson.UpdateString("initialUser.createdDateTime","sample string 10")
loJson.UpdateString("initialUser.firstName","sample string 11")
loJson.UpdateString("initialUser.middleName","sample string 12")
loJson.UpdateString("initialUser.lastName","sample string 13")
loJson.UpdateString("initialUser.suffixName","sample string 14")
loJson.UpdateString("initialUser.permissionProfileId","sample string 15")
loJson.UpdateString("initialUser.permissionProfileName","sample string 16")
loJson.UpdateString("initialUser.countryCode","sample string 17")
loJson.UpdateString("initialUser.subscribe","sample string 18")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsers","sample string 1")
loJson.UpdateString("initialUser.accountManagementGranular.canManageAdmins","sample string 2")
loJson.UpdateString("initialUser.accountManagementGranular.canManageGroups","sample string 3")
loJson.UpdateString("initialUser.accountManagementGranular.canManageSharing","sample string 4")
loJson.UpdateString("initialUser.accountManagementGranular.canManageEnvelopeTransfer","sample string 5")
loJson.UpdateString("initialUser.accountManagementGranular.canManageAccountSettings","sample string 6")
loJson.UpdateString("initialUser.accountManagementGranular.canManageReporting","sample string 7")
loJson.UpdateString("initialUser.accountManagementGranular.canManageAccountSecuritySettings","sample string 8")
loJson.UpdateString("initialUser.accountManagementGranular.canManageSigningGroups","sample string 9")
loJson.UpdateString("initialUser.accountManagementGranular.canManageDocumentRetention","sample string 10")
loJson.UpdateString("initialUser.accountManagementGranular.canViewUsers","sample string 11")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.rights","sample string 1")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.uiHint","sample string 2")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.uiType","sample string 3")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.uiOrder","sample string 4")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.is21CFRPart11","sample string 5")
loJson.UpdateString("initialUser.accountManagementGranular.canManageUsersMetadata.options[0]","sample string 1")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageAdminsMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageGroupsMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageSharingMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageEnvelopeTransferMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageAccountSettingsMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageReportingMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageAccountSecuritySettingsMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageSigningGroupsMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canManageDocumentRetentionMetadata")
loJson.UpdateNewObject("initialUser.accountManagementGranular.canViewUsersMetadata")
loJson.UpdateString("initialUser.sendActivationOnInvalidLogin","sample string 19")
loJson.UpdateString("initialUser.activationAccessCode","sample string 20")
loJson.UpdateString("initialUser.enableConnectForUser","sample string 21")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordQuestion1","sample string 1")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordAnswer1","sample string 2")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordQuestion2","sample string 3")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordAnswer2","sample string 4")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordQuestion3","sample string 5")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordAnswer3","sample string 6")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordQuestion4","sample string 7")
loJson.UpdateString("initialUser.forgottenPasswordInfo.forgottenPasswordAnswer4","sample string 8")
loJson.UpdateString("initialUser.groupList[0].groupId","sample string 1")
loJson.UpdateString("initialUser.groupList[0].groupName","sample string 2")
loJson.UpdateString("initialUser.groupList[0].permissionProfileId","sample string 3")
loJson.UpdateString("initialUser.groupList[0].groupType","sample string 4")
loJson.UpdateString("initialUser.groupList[0].users[0].userName","sample string 1")
loJson.UpdateString("initialUser.groupList[0].users[0].userId","sample string 2")
loJson.UpdateString("initialUser.groupList[0].users[0].email","sample string 3")
loJson.UpdateString("initialUser.groupList[0].users[0].userType","sample string 4")
loJson.UpdateString("initialUser.groupList[0].users[0].userStatus","sample string 5")
loJson.UpdateString("initialUser.groupList[0].users[0].uri","sample string 6")
loJson.UpdateString("initialUser.groupList[0].users[0].loginStatus","sample string 7")
loJson.UpdateString("initialUser.groupList[0].users[0].sendActivationEmail","sample string 8")
loJson.UpdateString("initialUser.groupList[0].users[0].activationAccessCode","sample string 9")
loJson.UpdateString("initialUser.workAddress.address1","sample string 1")
loJson.UpdateString("initialUser.workAddress.address2","sample string 2")
loJson.UpdateString("initialUser.workAddress.city","sample string 3")
loJson.UpdateString("initialUser.workAddress.stateOrProvince","sample string 4")
loJson.UpdateString("initialUser.workAddress.postalCode","sample string 5")
loJson.UpdateString("initialUser.workAddress.phone","sample string 6")
loJson.UpdateString("initialUser.workAddress.fax","sample string 7")
loJson.UpdateString("initialUser.workAddress.country","sample string 8")
loJson.UpdateNewObject("initialUser.homeAddress")
loJson.UpdateString("initialUser.loginStatus","sample string 22")
loJson.UpdateString("initialUser.passwordExpiration","sample string 23")
loJson.UpdateString("initialUser.lastLogin","sample string 24")
loJson.UpdateString("initialUser.sendActivationEmail","sample string 25")
loJson.UpdateString("initialUser.profileImageUri","sample string 26")
loJson.UpdateString("initialUser.userProfileLastModifiedDate","sample string 27")
loJson.UpdateString("initialUser.signatureImageUri","sample string 28")
loJson.UpdateString("initialUser.initialsImageUri","sample string 29")
loJson.UpdateString("initialUser.jobTitle","sample string 30")
loJson.UpdateString("addressInformation.address1","sample string 1")
loJson.UpdateString("addressInformation.address2","sample string 2")
loJson.UpdateString("addressInformation.city","sample string 3")
loJson.UpdateString("addressInformation.state","sample string 4")
loJson.UpdateString("addressInformation.postalCode","sample string 5")
loJson.UpdateString("addressInformation.phone","sample string 6")
loJson.UpdateString("addressInformation.fax","sample string 7")
loJson.UpdateString("addressInformation.country","sample string 8")
loJson.UpdateString("addressInformation.firstName","sample string 9")
loJson.UpdateString("addressInformation.lastName","sample string 10")
loJson.UpdateString("addressInformation.email","sample string 11")
loJson.UpdateString("addressInformation.supportedCountries[0].isoCode","sample string 1")
loJson.UpdateString("addressInformation.supportedCountries[0].provinceValidated","sample string 2")
loJson.UpdateString("addressInformation.supportedCountries[0].name","sample string 3")
loJson.UpdateString("addressInformation.supportedCountries[0].provinces[0].isoCode","sample string 1")
loJson.UpdateString("addressInformation.supportedCountries[0].provinces[0].name","sample string 2")
loJson.UpdateString("socialAccountInformation.provider","sample string 1")
loJson.UpdateString("socialAccountInformation.email","sample string 2")
loJson.UpdateString("socialAccountInformation.socialId","sample string 3")
loJson.UpdateString("socialAccountInformation.userName","sample string 4")
loJson.UpdateString("PaymentProcessorInformation.billingAgreementId","sample string 1")
loJson.UpdateString("PaymentProcessorInformation.email","sample string 2")
loJson.UpdateNewObject("PaymentProcessorInformation.address")
loJson.UpdateNull("envelopePartitionId")
* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.PostJson3("https://domain.com/v2.1/accounts?preview_billing_plan={{preview_billing_plan}}","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp
RELEASE loHttp
RELEASE loJson
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"accountName": "sample string 1",
"distributorCode": "sample string 2",
"distributorPassword": "sample string 3",
"planInformation": {
"planId": "sample string 1",
"planFeatureSets": [
{
"featureSetId": "sample string 1",
"isActive": "sample string 2",
"name": "sample string 3",
"fixedFee": "sample string 4",
"envelopeFee": "sample string 5",
"seatFee": "sample string 6",
"isEnabled": "sample string 7",
"is21CFRPart11": "sample string 8",
"currencyFeatureSetPrices": [
{
"currencyCode": "sample string 1",
"fixedFee": "sample string 2",
"seatFee": "sample string 3",
"envelopeFee": "sample string 4",
"currencySymbol": "sample string 5"
}
]
}
],
"addOns": [
{
"id": "sample string 1",
"addOnId": "sample string 2",
"name": "sample string 3",
"active": "sample string 4"
}
],
"recipientDomains": [
{
"recipientDomainId": "sample string 1",
"domainCode": "sample string 2",
"domainName": "sample string 3",
"active": "sample string 4"
}
],
"currencyCode": "sample string 2",
"freeTrialDaysOverride": "sample string 3"
},
"creditCardInformation": {
"cardNumber": "sample string 1",
"expirationMonth": "sample string 2",
"expirationYear": "sample string 3",
"nameOnCard": "sample string 4",
"cardType": "sample string 5",
"address": {
"street1": "sample string 1",
"street2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"zip": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8",
"zipPlus4": "sample string 9"
}
},
"referralInformation": {
"enableSupport": "sample string 1",
"includedSeats": "sample string 2",
"saleDiscountPercent": "sample string 3",
"saleDiscountAmount": "sample string 4",
"saleDiscountFixedAmount": "sample string 5",
"saleDiscountPeriods": "sample string 6",
"saleDiscountSeatPriceOverride": "sample string 7",
"planStartMonth": "sample string 8",
"referralCode": "sample string 9",
"referrerName": "sample string 10",
"advertisementId": "sample string 11",
"publisherId": "sample string 12",
"shopperId": "sample string 13",
"promoCode": "sample string 14",
"groupMemberId": "sample string 15",
"idType": "sample string 16",
"industry": "sample string 17",
"externalOrgId": "sample string 18"
},
"accountSettings": [
{}
],
"initialUser": {
"userName": "sample string 1",
"userId": "sample string 2",
"userType": "sample string 3",
"isAdmin": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"email": "sample string 7",
"password": "sample string 8",
"title": "sample string 9",
"createdDateTime": "sample string 10",
"firstName": "sample string 11",
"middleName": "sample string 12",
"lastName": "sample string 13",
"suffixName": "sample string 14",
"permissionProfileId": "sample string 15",
"permissionProfileName": "sample string 16",
"countryCode": "sample string 17",
"subscribe": "sample string 18",
"userSettings": [
{}
],
"accountManagementGranular": {
"canManageUsers": "sample string 1",
"canManageAdmins": "sample string 2",
"canManageGroups": "sample string 3",
"canManageSharing": "sample string 4",
"canManageEnvelopeTransfer": "sample string 5",
"canManageAccountSettings": "sample string 6",
"canManageReporting": "sample string 7",
"canManageAccountSecuritySettings": "sample string 8",
"canManageSigningGroups": "sample string 9",
"canManageDocumentRetention": "sample string 10",
"canViewUsers": "sample string 11",
"canManageUsersMetadata": {
"rights": "sample string 1",
"uiHint": "sample string 2",
"uiType": "sample string 3",
"uiOrder": "sample string 4",
"is21CFRPart11": "sample string 5",
"options": [
"sample string 1"
]
},
"canManageAdminsMetadata": {},
"canManageGroupsMetadata": {},
"canManageSharingMetadata": {},
"canManageEnvelopeTransferMetadata": {},
"canManageAccountSettingsMetadata": {},
"canManageReportingMetadata": {},
"canManageAccountSecuritySettingsMetadata": {},
"canManageSigningGroupsMetadata": {},
"canManageDocumentRetentionMetadata": {},
"canViewUsersMetadata": {}
},
"sendActivationOnInvalidLogin": "sample string 19",
"activationAccessCode": "sample string 20",
"enableConnectForUser": "sample string 21",
"forgottenPasswordInfo": {
"forgottenPasswordQuestion1": "sample string 1",
"forgottenPasswordAnswer1": "sample string 2",
"forgottenPasswordQuestion2": "sample string 3",
"forgottenPasswordAnswer2": "sample string 4",
"forgottenPasswordQuestion3": "sample string 5",
"forgottenPasswordAnswer3": "sample string 6",
"forgottenPasswordQuestion4": "sample string 7",
"forgottenPasswordAnswer4": "sample string 8"
},
"groupList": [
{
"groupId": "sample string 1",
"groupName": "sample string 2",
"permissionProfileId": "sample string 3",
"groupType": "sample string 4",
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9"
}
]
}
],
"workAddress": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"stateOrProvince": "sample string 4",
"postalCode": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8"
},
"homeAddress": {},
"loginStatus": "sample string 22",
"passwordExpiration": "sample string 23",
"lastLogin": "sample string 24",
"sendActivationEmail": "sample string 25",
"customSettings": [
{}
],
"profileImageUri": "sample string 26",
"userProfileLastModifiedDate": "sample string 27",
"signatureImageUri": "sample string 28",
"initialsImageUri": "sample string 29",
"jobTitle": "sample string 30"
},
"addressInformation": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"state": "sample string 4",
"postalCode": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8",
"firstName": "sample string 9",
"lastName": "sample string 10",
"email": "sample string 11",
"supportedCountries": [
{
"isoCode": "sample string 1",
"provinceValidated": "sample string 2",
"name": "sample string 3",
"provinces": [
{
"isoCode": "sample string 1",
"name": "sample string 2"
}
]
}
]
},
"socialAccountInformation": {
"provider": "sample string 1",
"email": "sample string 2",
"socialId": "sample string 3",
"userName": "sample string 4"
},
"PaymentProcessorInformation": {
"billingAgreementId": "sample string 1",
"email": "sample string 2",
"address": {}
},
"envelopePartitionId": null
}'
https://domain.com/v2.1/accounts?preview_billing_plan={{preview_billing_plan}}
Postman Collection Item JSON
{
"name": "Creates new accounts.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"accountName\": \"sample string 1\",\n \"distributorCode\": \"sample string 2\",\n \"distributorPassword\": \"sample string 3\",\n \"planInformation\": {\n \"planId\": \"sample string 1\",\n \"planFeatureSets\": [\n {\n \"featureSetId\": \"sample string 1\",\n \"isActive\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"fixedFee\": \"sample string 4\",\n \"envelopeFee\": \"sample string 5\",\n \"seatFee\": \"sample string 6\",\n \"isEnabled\": \"sample string 7\",\n \"is21CFRPart11\": \"sample string 8\",\n \"currencyFeatureSetPrices\": [\n {\n \"currencyCode\": \"sample string 1\",\n \"fixedFee\": \"sample string 2\",\n \"seatFee\": \"sample string 3\",\n \"envelopeFee\": \"sample string 4\",\n \"currencySymbol\": \"sample string 5\"\n }\n ]\n }\n ],\n \"addOns\": [\n {\n \"id\": \"sample string 1\",\n \"addOnId\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"active\": \"sample string 4\"\n }\n ],\n \"recipientDomains\": [\n {\n \"recipientDomainId\": \"sample string 1\",\n \"domainCode\": \"sample string 2\",\n \"domainName\": \"sample string 3\",\n \"active\": \"sample string 4\"\n }\n ],\n \"currencyCode\": \"sample string 2\",\n \"freeTrialDaysOverride\": \"sample string 3\"\n },\n \"creditCardInformation\": {\n \"cardNumber\": \"sample string 1\",\n \"expirationMonth\": \"sample string 2\",\n \"expirationYear\": \"sample string 3\",\n \"nameOnCard\": \"sample string 4\",\n \"cardType\": \"sample string 5\",\n \"address\": {\n \"street1\": \"sample string 1\",\n \"street2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"zip\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\",\n \"zipPlus4\": \"sample string 9\"\n }\n },\n \"referralInformation\": {\n \"enableSupport\": \"sample string 1\",\n \"includedSeats\": \"sample string 2\",\n \"saleDiscountPercent\": \"sample string 3\",\n \"saleDiscountAmount\": \"sample string 4\",\n \"saleDiscountFixedAmount\": \"sample string 5\",\n \"saleDiscountPeriods\": \"sample string 6\",\n \"saleDiscountSeatPriceOverride\": \"sample string 7\",\n \"planStartMonth\": \"sample string 8\",\n \"referralCode\": \"sample string 9\",\n \"referrerName\": \"sample string 10\",\n \"advertisementId\": \"sample string 11\",\n \"publisherId\": \"sample string 12\",\n \"shopperId\": \"sample string 13\",\n \"promoCode\": \"sample string 14\",\n \"groupMemberId\": \"sample string 15\",\n \"idType\": \"sample string 16\",\n \"industry\": \"sample string 17\",\n \"externalOrgId\": \"sample string 18\"\n },\n \"accountSettings\": [\n {}\n ],\n \"initialUser\": {\n \"userName\": \"sample string 1\",\n \"userId\": \"sample string 2\",\n \"userType\": \"sample string 3\",\n \"isAdmin\": \"sample string 4\",\n \"userStatus\": \"sample string 5\",\n \"uri\": \"sample string 6\",\n \"email\": \"sample string 7\",\n \"password\": \"sample string 8\",\n \"title\": \"sample string 9\",\n \"createdDateTime\": \"sample string 10\",\n \"firstName\": \"sample string 11\",\n \"middleName\": \"sample string 12\",\n \"lastName\": \"sample string 13\",\n \"suffixName\": \"sample string 14\",\n \"permissionProfileId\": \"sample string 15\",\n \"permissionProfileName\": \"sample string 16\",\n \"countryCode\": \"sample string 17\",\n \"subscribe\": \"sample string 18\",\n \"userSettings\": [\n {}\n ],\n \"accountManagementGranular\": {\n \"canManageUsers\": \"sample string 1\",\n \"canManageAdmins\": \"sample string 2\",\n \"canManageGroups\": \"sample string 3\",\n \"canManageSharing\": \"sample string 4\",\n \"canManageEnvelopeTransfer\": \"sample string 5\",\n \"canManageAccountSettings\": \"sample string 6\",\n \"canManageReporting\": \"sample string 7\",\n \"canManageAccountSecuritySettings\": \"sample string 8\",\n \"canManageSigningGroups\": \"sample string 9\",\n \"canManageDocumentRetention\": \"sample string 10\",\n \"canViewUsers\": \"sample string 11\",\n \"canManageUsersMetadata\": {\n \"rights\": \"sample string 1\",\n \"uiHint\": \"sample string 2\",\n \"uiType\": \"sample string 3\",\n \"uiOrder\": \"sample string 4\",\n \"is21CFRPart11\": \"sample string 5\",\n \"options\": [\n \"sample string 1\"\n ]\n },\n \"canManageAdminsMetadata\": {},\n \"canManageGroupsMetadata\": {},\n \"canManageSharingMetadata\": {},\n \"canManageEnvelopeTransferMetadata\": {},\n \"canManageAccountSettingsMetadata\": {},\n \"canManageReportingMetadata\": {},\n \"canManageAccountSecuritySettingsMetadata\": {},\n \"canManageSigningGroupsMetadata\": {},\n \"canManageDocumentRetentionMetadata\": {},\n \"canViewUsersMetadata\": {}\n },\n \"sendActivationOnInvalidLogin\": \"sample string 19\",\n \"activationAccessCode\": \"sample string 20\",\n \"enableConnectForUser\": \"sample string 21\",\n \"forgottenPasswordInfo\": {\n \"forgottenPasswordQuestion1\": \"sample string 1\",\n \"forgottenPasswordAnswer1\": \"sample string 2\",\n \"forgottenPasswordQuestion2\": \"sample string 3\",\n \"forgottenPasswordAnswer2\": \"sample string 4\",\n \"forgottenPasswordQuestion3\": \"sample string 5\",\n \"forgottenPasswordAnswer3\": \"sample string 6\",\n \"forgottenPasswordQuestion4\": \"sample string 7\",\n \"forgottenPasswordAnswer4\": \"sample string 8\"\n },\n \"groupList\": [\n {\n \"groupId\": \"sample string 1\",\n \"groupName\": \"sample string 2\",\n \"permissionProfileId\": \"sample string 3\",\n \"groupType\": \"sample string 4\",\n \"users\": [\n {\n \"userName\": \"sample string 1\",\n \"userId\": \"sample string 2\",\n \"email\": \"sample string 3\",\n \"userType\": \"sample string 4\",\n \"userStatus\": \"sample string 5\",\n \"uri\": \"sample string 6\",\n \"loginStatus\": \"sample string 7\",\n \"sendActivationEmail\": \"sample string 8\",\n \"activationAccessCode\": \"sample string 9\"\n }\n ]\n }\n ],\n \"workAddress\": {\n \"address1\": \"sample string 1\",\n \"address2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"stateOrProvince\": \"sample string 4\",\n \"postalCode\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\"\n },\n \"homeAddress\": {},\n \"loginStatus\": \"sample string 22\",\n \"passwordExpiration\": \"sample string 23\",\n \"lastLogin\": \"sample string 24\",\n \"sendActivationEmail\": \"sample string 25\",\n \"customSettings\": [\n {}\n ],\n \"profileImageUri\": \"sample string 26\",\n \"userProfileLastModifiedDate\": \"sample string 27\",\n \"signatureImageUri\": \"sample string 28\",\n \"initialsImageUri\": \"sample string 29\",\n \"jobTitle\": \"sample string 30\"\n },\n \"addressInformation\": {\n \"address1\": \"sample string 1\",\n \"address2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"state\": \"sample string 4\",\n \"postalCode\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\",\n \"firstName\": \"sample string 9\",\n \"lastName\": \"sample string 10\",\n \"email\": \"sample string 11\",\n \"supportedCountries\": [\n {\n \"isoCode\": \"sample string 1\",\n \"provinceValidated\": \"sample string 2\",\n \"name\": \"sample string 3\",\n \"provinces\": [\n {\n \"isoCode\": \"sample string 1\",\n \"name\": \"sample string 2\"\n }\n ]\n }\n ]\n },\n \"socialAccountInformation\": {\n \"provider\": \"sample string 1\",\n \"email\": \"sample string 2\",\n \"socialId\": \"sample string 3\",\n \"userName\": \"sample string 4\"\n },\n \"PaymentProcessorInformation\": {\n \"billingAgreementId\": \"sample string 1\",\n \"email\": \"sample string 2\",\n \"address\": {}\n },\n \"envelopePartitionId\": null\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts?preview_billing_plan={{preview_billing_plan}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts"
],
"query": [
{
"key": "preview_billing_plan",
"value": "{{preview_billing_plan}}"
}
]
},
"description": "Creates new DocuSign service accounts.\n\nThis is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a [Accounts:create](accounts_create) call with the information included within a `newAccountRequests` element. A maximum of 100 new accounts can be created at one time.\n\nNote that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a `newAccountDefinition` property inside the `newAccountRequests` element.\nResponse\n\nThe response returns the new account ID, password and the default user information for each newly created account.\n\nA 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an `errorDetails` node is added in the response to each specific request that failed."
},
"response": [
]
}
