Create a new online account
Create a new online Omni Channel for your customers.
After creating an online account, we are also creating your first Admin account and you can immediately access it.
Settings:
URL | |
Method | JSON via POST |
Header | Authorization: Bearer {{access_token}} *The access_token can be received from settings->get access token API. |
Body:
Parameter | Description / Example | Maximum length | Mandatory | Example |
account_name | The account (business) name that will be created | 100 | Yes | Acme inc |
agents | The total agents you allow for this account to create | 4 | Yes | 10 |
inboxes | The total inboxes you allow for this account to create | 3 | Yes | 10 |
admin_email | Admin access email that will be created as agent number 1 for this account | 50 | Yes | |
admin_name | The agent number 1 name | 50 | Yes | Test Name |
admin_displayName | The agent number 1 display name (that will appear in the online account) | 50 | Yes | Name |
admin_password | The password to create for login to the new admin account. - minimum 6 characters length. - at least 1 upper case (A-Z) - at least 1 lower case (a-z) - at least 1 special character ( !@#$%^&*()_+-=[]{}|\"/\\.,<>:;?~') | 50 | Yes | {strong_password} |
admin_2fa | Either to allow login to the admin account with 2FA or not values: 0 - no 2FA 1 - email 2FA 2 - SMS 2FA The default, in case you don't send anything, will be 0 | 1 | no | 1 |
admin_2fa_value | in case you used 1/2 in "admin_2fa" here you can provide the email address or phone number (international number, without + for example 972501234567) to get the 2FA code before you can login with that new agent | 50 | no | |
server | If you wish to install the account on a server other than the main server (online.99digital.co.il) please provide here the subdomain of the server. ** this feature only available for selected partners | 30 | no | online |
reference | Any reference value (text/numbers only) you wish to receive back on the webhook. this is for your use only so you can recognize your client | 50 | no |
Important notice:
If you create admin_email with email that already exist under any of your accounts, we will not try to re-create this email or change any parameters (admin_name,admin_displayName and admin_loginPassword won't be used) instead, we will just allow this email address to have now access to this new account that you are creating. this will not override existing permissions, it will just add this existing agent email to the new account.
Response:
{
"status": "OK",
"reason": 1
"account_id": 8,
"agent_id": 100,
"server": "online
}
Response-Explain:
Parameter | Description | ||||||||||||||||||||||||||||
status | OK or FAIL "OK" means the request was successful "Fail" means error. | ||||||||||||||||||||||||||||
account_id | The newly created account ID | ||||||||||||||||||||||||||||
agent_id | The newly created agent ID, this agent can now login to the platform | ||||||||||||||||||||||||||||
server | The server subdomain that this account created on https://{{server}}.99digital.co.il | ||||||||||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|