Customer API V1.0
API change historycreateCustomerAccount
Requires account type "Partner" or above
The API endpoint can be used to create customer accounts.
Try itRequest
Request URL
Request headers
-
(optional)string
Customer API Key generated in Admin Portal
-
(optional)stringMedia type of the body sent to the API.
Request body
Parameters responsible for new customer profile details.
{
"companyName": "string",
"eula": 0,
"templateId": 0,
"accountType": 0,
"contractStatus": 0,
"routeURL": "string",
"domains": [
"string"
],
"primaryContact": {
"name": "string",
"email": "string",
"phone": "string"
},
"expirationDate": "string",
"licenses": 0,
"timeZone": 0,
"supportInfo": {
"website": "string",
"email": "string",
"phone": "string"
},
"partnerId": 0,
"ae": 0,
"csm": 0,
"suppressUserCreation": true,
"isEulaAccepted": true,
"sandBoxModeOn": true,
"skUs": [
{
"licenseCount": 0,
"skuId": 0
}
]
}{
"type": "object",
"properties": {
"companyName": {
"description": "Parameter responsible for providing name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking new customer with End-User License Agreement file.",
"type": "integer"
},
"templateId": {
"format": "int32",
"description": "Parameter responsible for assigning template to new customer by adding Template ID for more flexible management.",
"type": "integer"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for settings url for new customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to. E.g. [\"string\", \"string1\", \"string2\"].",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "Parameter that contains Name, Email and Phone of contact person for new customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for setup expiration date for new customer.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for setup number of licenses for new customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for stetting Time Zone for new customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array containing contact information as phone, email, and website."
},
"partnerId": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for specifying Partner Customer that new Child Customer will belong to.",
"type": "integer"
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to new customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to new customer.",
"type": "integer"
},
"suppressUserCreation": {
"description": "Parameter responsible for assigning Primary Contact Person as Customer Administrator.",
"type": "boolean"
},
"isEulaAccepted": {
"description": "Parameter responsible for new customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"sandBoxModeOn": {
"description": "Parameter responsible for creation new customer in SandBox (default = false)",
"type": "boolean"
},
"skUs": {
"description": "An array that may contain multiple SKUs that should be enabled for new customer. E.g. [{ \"SkuId\": 23, \"LicenseCount\": 34 }, { \"SkuId\": 12, \"LicenseCount\": 433 }].",
"type": "array",
"items": {
"type": "object",
"properties": {
"licenseCount": {
"format": "int32",
"description": "Required - Licenses count.",
"type": "integer"
},
"skuId": {
"format": "int32",
"description": "SKU id",
"type": "integer"
}
}
}
}
}
}{
"companyName": "string",
"eula": 0,
"templateId": 0,
"accountType": 0,
"contractStatus": 0,
"routeURL": "string",
"domains": [
"string"
],
"primaryContact": {
"name": "string",
"email": "string",
"phone": "string"
},
"expirationDate": "string",
"licenses": 0,
"timeZone": 0,
"supportInfo": {
"website": "string",
"email": "string",
"phone": "string"
},
"partnerId": 0,
"ae": 0,
"csm": 0,
"suppressUserCreation": true,
"isEulaAccepted": true,
"sandBoxModeOn": true,
"skUs": [
{
"licenseCount": 0,
"skuId": 0
}
]
}{
"type": "object",
"properties": {
"companyName": {
"description": "Parameter responsible for providing name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking new customer with End-User License Agreement file.",
"type": "integer"
},
"templateId": {
"format": "int32",
"description": "Parameter responsible for assigning template to new customer by adding Template ID for more flexible management.",
"type": "integer"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for settings url for new customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to. E.g. [\"string\", \"string1\", \"string2\"].",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "Parameter that contains Name, Email and Phone of contact person for new customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for setup expiration date for new customer.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for setup number of licenses for new customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for stetting Time Zone for new customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array containing contact information as phone, email, and website."
},
"partnerId": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for specifying Partner Customer that new Child Customer will belong to.",
"type": "integer"
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to new customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to new customer.",
"type": "integer"
},
"suppressUserCreation": {
"description": "Parameter responsible for assigning Primary Contact Person as Customer Administrator.",
"type": "boolean"
},
"isEulaAccepted": {
"description": "Parameter responsible for new customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"sandBoxModeOn": {
"description": "Parameter responsible for creation new customer in SandBox (default = false)",
"type": "boolean"
},
"skUs": {
"description": "An array that may contain multiple SKUs that should be enabled for new customer. E.g. [{ \"SkuId\": 23, \"LicenseCount\": 34 }, { \"SkuId\": 12, \"LicenseCount\": 433 }].",
"type": "array",
"items": {
"type": "object",
"properties": {
"licenseCount": {
"format": "int32",
"description": "Required - Licenses count.",
"type": "integer"
},
"skuId": {
"format": "int32",
"description": "SKU id",
"type": "integer"
}
}
}
}
}
}<AccountCreationDto>
<companyName>string</companyName>
<eula>0</eula>
<templateId>0</templateId>
<accountType>0</accountType>
<contractStatus>0</contractStatus>
<routeURL>string</routeURL>
<domains>string</domains>
<primaryContact>
<name>string</name>
<email>string</email>
<phone>string</phone>
</primaryContact>
<expirationDate>string</expirationDate>
<licenses>0</licenses>
<timeZone>0</timeZone>
<supportInfo>
<website>string</website>
<email>string</email>
<phone>string</phone>
</supportInfo>
<partnerId>0</partnerId>
<ae>0</ae>
<csm>0</csm>
<suppressUserCreation>true</suppressUserCreation>
<isEulaAccepted>true</isEulaAccepted>
<sandBoxModeOn>true</sandBoxModeOn>
<skUs>
<licenseCount>0</licenseCount>
<skuId>0</skuId>
</skUs>
</AccountCreationDto>{
"type": "object",
"properties": {
"companyName": {
"description": "Parameter responsible for providing name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking new customer with End-User License Agreement file.",
"type": "integer"
},
"templateId": {
"format": "int32",
"description": "Parameter responsible for assigning template to new customer by adding Template ID for more flexible management.",
"type": "integer"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for settings url for new customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to. E.g. [\"string\", \"string1\", \"string2\"].",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "Parameter that contains Name, Email and Phone of contact person for new customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for setup expiration date for new customer.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for setup number of licenses for new customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for stetting Time Zone for new customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array containing contact information as phone, email, and website."
},
"partnerId": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for specifying Partner Customer that new Child Customer will belong to.",
"type": "integer"
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to new customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to new customer.",
"type": "integer"
},
"suppressUserCreation": {
"description": "Parameter responsible for assigning Primary Contact Person as Customer Administrator.",
"type": "boolean"
},
"isEulaAccepted": {
"description": "Parameter responsible for new customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"sandBoxModeOn": {
"description": "Parameter responsible for creation new customer in SandBox (default = false)",
"type": "boolean"
},
"skUs": {
"description": "An array that may contain multiple SKUs that should be enabled for new customer. E.g. [{ \"SkuId\": 23, \"LicenseCount\": 34 }, { \"SkuId\": 12, \"LicenseCount\": 433 }].",
"type": "array",
"items": {
"type": "object",
"properties": {
"licenseCount": {
"format": "int32",
"description": "Required - Licenses count.",
"type": "integer"
},
"skuId": {
"format": "int32",
"description": "SKU id",
"type": "integer"
}
}
}
}
}
}<AccountCreationDto>
<companyName>string</companyName>
<eula>0</eula>
<templateId>0</templateId>
<accountType>0</accountType>
<contractStatus>0</contractStatus>
<routeURL>string</routeURL>
<domains>string</domains>
<primaryContact>
<name>string</name>
<email>string</email>
<phone>string</phone>
</primaryContact>
<expirationDate>string</expirationDate>
<licenses>0</licenses>
<timeZone>0</timeZone>
<supportInfo>
<website>string</website>
<email>string</email>
<phone>string</phone>
</supportInfo>
<partnerId>0</partnerId>
<ae>0</ae>
<csm>0</csm>
<suppressUserCreation>true</suppressUserCreation>
<isEulaAccepted>true</isEulaAccepted>
<sandBoxModeOn>true</sandBoxModeOn>
<skUs>
<licenseCount>0</licenseCount>
<skuId>0</skuId>
</skUs>
</AccountCreationDto>{
"type": "object",
"properties": {
"companyName": {
"description": "Parameter responsible for providing name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking new customer with End-User License Agreement file.",
"type": "integer"
},
"templateId": {
"format": "int32",
"description": "Parameter responsible for assigning template to new customer by adding Template ID for more flexible management.",
"type": "integer"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for settings url for new customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to. E.g. [\"string\", \"string1\", \"string2\"].",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "Parameter that contains Name, Email and Phone of contact person for new customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for setup expiration date for new customer.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for setup number of licenses for new customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for stetting Time Zone for new customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array containing contact information as phone, email, and website."
},
"partnerId": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for specifying Partner Customer that new Child Customer will belong to.",
"type": "integer"
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to new customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to new customer.",
"type": "integer"
},
"suppressUserCreation": {
"description": "Parameter responsible for assigning Primary Contact Person as Customer Administrator.",
"type": "boolean"
},
"isEulaAccepted": {
"description": "Parameter responsible for new customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"sandBoxModeOn": {
"description": "Parameter responsible for creation new customer in SandBox (default = false)",
"type": "boolean"
},
"skUs": {
"description": "An array that may contain multiple SKUs that should be enabled for new customer. E.g. [{ \"SkuId\": 23, \"LicenseCount\": 34 }, { \"SkuId\": 12, \"LicenseCount\": 433 }].",
"type": "array",
"items": {
"type": "object",
"properties": {
"licenseCount": {
"format": "int32",
"description": "Required - Licenses count.",
"type": "integer"
},
"skuId": {
"format": "int32",
"description": "SKU id",
"type": "integer"
}
}
}
}
}
}Responses
200 OK
OK
Representations
{
"customerId": 0,
"companyName": "string",
"eula": 0,
"isEulaAccepted": true,
"accountType": 0,
"routeURL": "string",
"domains": [
"string"
],
"primaryContact": {
"name": "string",
"email": "string",
"phone": "string"
},
"expirationDate": "string",
"licenses": 0,
"timeZone": 0,
"supportInfo": {
"website": "string",
"email": "string",
"phone": "string"
},
"ae": 0,
"csm": 0,
"contractStatus": 0,
"isActive": true,
"launchCustomer": true
}{
"type": "object",
"properties": {
"customerId": {
"format": "int32",
"description": "Parameter responsible for filtering data per specific customer.",
"type": "integer"
},
"companyName": {
"description": "Parameter responsible for updating name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking customer with new End-User License Agreement file.",
"type": "integer"
},
"isEulaAccepted": {
"description": "Parameter responsible for customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for updating url for customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to.",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "An associative array that contains Name, Email and Phone of contact person from customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for update expiration date for customer. This parameter available only for BSI.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for update number of licenses for customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for update Time Zone for customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array responsible for update contact information as phone, email, and website."
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to customer.",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2.",
"type": "integer"
},
"isActive": {
"description": "Parameter responsible for activation and deactivation of customer (Active = True; Inactive = False).",
"type": "boolean"
},
"launchCustomer": {
"description": "Parameter responsible for launching customer from SandBox (default false)",
"type": "boolean"
}
}
}{
"customerId": 0,
"companyName": "string",
"eula": 0,
"isEulaAccepted": true,
"accountType": 0,
"routeURL": "string",
"domains": [
"string"
],
"primaryContact": {
"name": "string",
"email": "string",
"phone": "string"
},
"expirationDate": "string",
"licenses": 0,
"timeZone": 0,
"supportInfo": {
"website": "string",
"email": "string",
"phone": "string"
},
"ae": 0,
"csm": 0,
"contractStatus": 0,
"isActive": true,
"launchCustomer": true
}{
"type": "object",
"properties": {
"customerId": {
"format": "int32",
"description": "Parameter responsible for filtering data per specific customer.",
"type": "integer"
},
"companyName": {
"description": "Parameter responsible for updating name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking customer with new End-User License Agreement file.",
"type": "integer"
},
"isEulaAccepted": {
"description": "Parameter responsible for customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for updating url for customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to.",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "An associative array that contains Name, Email and Phone of contact person from customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for update expiration date for customer. This parameter available only for BSI.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for update number of licenses for customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for update Time Zone for customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array responsible for update contact information as phone, email, and website."
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to customer.",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2.",
"type": "integer"
},
"isActive": {
"description": "Parameter responsible for activation and deactivation of customer (Active = True; Inactive = False).",
"type": "boolean"
},
"launchCustomer": {
"description": "Parameter responsible for launching customer from SandBox (default false)",
"type": "boolean"
}
}
}<AccountUpdateDto>
<customerId>0</customerId>
<companyName>string</companyName>
<eula>0</eula>
<isEulaAccepted>true</isEulaAccepted>
<accountType>0</accountType>
<routeURL>string</routeURL>
<domains>string</domains>
<primaryContact>
<name>string</name>
<email>string</email>
<phone>string</phone>
</primaryContact>
<expirationDate>string</expirationDate>
<licenses>0</licenses>
<timeZone>0</timeZone>
<supportInfo>
<website>string</website>
<email>string</email>
<phone>string</phone>
</supportInfo>
<ae>0</ae>
<csm>0</csm>
<contractStatus>0</contractStatus>
<isActive>true</isActive>
<launchCustomer>true</launchCustomer>
</AccountUpdateDto>{
"type": "object",
"properties": {
"customerId": {
"format": "int32",
"description": "Parameter responsible for filtering data per specific customer.",
"type": "integer"
},
"companyName": {
"description": "Parameter responsible for updating name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking customer with new End-User License Agreement file.",
"type": "integer"
},
"isEulaAccepted": {
"description": "Parameter responsible for customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for updating url for customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to.",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "An associative array that contains Name, Email and Phone of contact person from customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for update expiration date for customer. This parameter available only for BSI.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for update number of licenses for customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for update Time Zone for customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array responsible for update contact information as phone, email, and website."
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to customer.",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2.",
"type": "integer"
},
"isActive": {
"description": "Parameter responsible for activation and deactivation of customer (Active = True; Inactive = False).",
"type": "boolean"
},
"launchCustomer": {
"description": "Parameter responsible for launching customer from SandBox (default false)",
"type": "boolean"
}
}
}<AccountUpdateDto>
<customerId>0</customerId>
<companyName>string</companyName>
<eula>0</eula>
<isEulaAccepted>true</isEulaAccepted>
<accountType>0</accountType>
<routeURL>string</routeURL>
<domains>string</domains>
<primaryContact>
<name>string</name>
<email>string</email>
<phone>string</phone>
</primaryContact>
<expirationDate>string</expirationDate>
<licenses>0</licenses>
<timeZone>0</timeZone>
<supportInfo>
<website>string</website>
<email>string</email>
<phone>string</phone>
</supportInfo>
<ae>0</ae>
<csm>0</csm>
<contractStatus>0</contractStatus>
<isActive>true</isActive>
<launchCustomer>true</launchCustomer>
</AccountUpdateDto>{
"type": "object",
"properties": {
"customerId": {
"format": "int32",
"description": "Parameter responsible for filtering data per specific customer.",
"type": "integer"
},
"companyName": {
"description": "Parameter responsible for updating name of the company.",
"type": "string"
},
"eula": {
"format": "int32",
"description": "Parameter responsible for linking customer with new End-User License Agreement file.",
"type": "integer"
},
"isEulaAccepted": {
"description": "Parameter responsible for customer End-User License Agreement status (Accepted = True; Not Accepted = False).",
"type": "boolean"
},
"accountType": {
"format": "int32",
"description": "Parameter responsible for assigning customer type for new customer. Possible values: \r\n 1 (Customer Account), \r\n 2 (BQP Customer), \r\n 3 (Demo Account), \r\n 4 (Partner Customer), \r\n 5 (45-Day Trial Customer), \r\n 6 (Internal Use), \r\n 7 (Child Customer), \r\n 11 (CIE Bootcamp), \r\n 12 (BSI Trial Customer), \r\n 13 (SMC Sandbox)",
"type": "integer"
},
"routeURL": {
"description": "Parameter responsible for updating url for customer.",
"type": "string"
},
"domains": {
"description": "An array that may contain multiple domains that new customer is linked to.",
"type": "array",
"items": {
"type": "string"
}
},
"primaryContact": {
"type": "object",
"properties": {
"name": {
"description": "Parameter that contains Name of contact person for customer.",
"type": "string"
},
"email": {
"description": "Parameter that contains Email of contact person for customer.",
"type": "string"
},
"phone": {
"description": "Parameter that contains Phone of contact person for customer.",
"type": "string"
}
},
"description": "An associative array that contains Name, Email and Phone of contact person from customer."
},
"expirationDate": {
"format": "date-time",
"description": "Parameter responsible for update expiration date for customer. This parameter available only for BSI.",
"type": "string"
},
"licenses": {
"format": "int32",
"description": "Parameter responsible for update number of licenses for customer.",
"type": "integer"
},
"timeZone": {
"format": "int32",
"description": "Parameter responsible for update Time Zone for customer.",
"type": "integer"
},
"supportInfo": {
"type": "object",
"properties": {
"website": {
"description": "Contact website.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"phone": {
"description": "Contact phone.",
"type": "string"
}
},
"description": "An associative array responsible for update contact information as phone, email, and website."
},
"ae": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to customer.",
"type": "integer"
},
"csm": {
"format": "int32",
"description": "Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to customer.",
"type": "integer"
},
"contractStatus": {
"format": "int32",
"description": "Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2.",
"type": "integer"
},
"isActive": {
"description": "Parameter responsible for activation and deactivation of customer (Active = True; Inactive = False).",
"type": "boolean"
},
"launchCustomer": {
"description": "Parameter responsible for launching customer from SandBox (default false)",
"type": "boolean"
}
}
}400 Bad Request
BadRequest
Representations
{}{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}{}{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}<AccountCreatePost400ApplicationXmlResponse />{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}<AccountCreatePost400TextXmlResponse />{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}403 Forbidden
Requires account type "Partner" or above.
Representations
Code samples
@ECHO OFF
curl -v -X POST "https://qhapi.quickhelp.com/v1/Account/Create"
-H "Authorization: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://qhapi.quickhelp.com/v1/Account/Create?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://qhapi.quickhelp.com/v1/Account/Create");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://qhapi.quickhelp.com/v1/Account/Create?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://qhapi.quickhelp.com/v1/Account/Create";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://qhapi.quickhelp.com/v1/Account/Create');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Authorization': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('qhapi.quickhelp.com')
conn.request("POST", "/v1/Account/Create?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Authorization': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('qhapi.quickhelp.com')
conn.request("POST", "/v1/Account/Create?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://qhapi.quickhelp.com/v1/Account/Create')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body