Create Sub-Account🔗︎
| HTTP Verb | Path |
|---|---|
| POST | https://api.us.textkernel.com/tx/accounts/api |
Create a new SaaS Sub-Account
Request Body🔗︎
AccountName 🔗︎ string required
AccountName🔗︎
A name for the new sub-account. Names must be less than 100 characters.
Region 🔗︎ string required
Region🔗︎
The Data Center this account will be located in. See Endpoints. One of:
- US
- EU
CreditsToAdd 🔗︎ decimal
CreditsToAdd🔗︎
How many SaaS Credits to allocate to this account. If this is not set, Unrestricted must be true
Unrestricted 🔗︎ bool
Unrestricted🔗︎
If the account should have unrestricted access to your SaaS Credits. If this is not set, CreditsToAdd must have a value greater than 0.
Sample JSON
json
{
"AccountName": "string",
"Region": "string",
"CreditsToAdd": 1000,
"Unrestricted": false
}
Response Body🔗︎
AccountId 🔗︎ string
AccountId🔗︎
The AccountId of the new account to be used when authenticating with the SaaS API.
ServiceKey 🔗︎ string
ServiceKey🔗︎
The ServiceKey of the new account to be used when authenticating with the SaaS API.
AccountName 🔗︎ string
AccountName🔗︎
The name of the new account. This will match the value used in the request.
Region 🔗︎ string
Region🔗︎
The Textkernel Data Center the new account belongs to. This will match the value used in the request.
Unrestricted 🔗︎ bool
Unrestricted🔗︎
Whether or not the account has unrestricted access to your SaaS Credits.
CreditsRemaining 🔗︎ decimal
CreditsRemaining🔗︎
Credits the Sub-Account has remaining of what's been allocated. When these run out, the account will lose service. This is only output if the account is not Unrestricted.
ErrorMessage 🔗︎ string
ErrorMessage🔗︎
If an error occured, this will give a detailed message on what happened. If no error occured, this will be empty.
Sample JSON
json
{
"AccountId": "string",
"ServiceKey": "string",
"AccountName": "string",
"Region": "string",
"MatchingEnabled": false,
"Active": true,
"Unrestricted": false,
"CreditsRemaining": 0,
"ErrorMessage": "string"
}