Update account
Update account allows you to change and set a few things for your online omnichannel account.
You can set and change only the relevant values that you want.
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_id | The account ID you wish to update | 7 | Yes | 8 |
server | The server subdomain of the account id | 50 | yes | online |
account_name | You can change the account name | 100 | no | My Account |
account_status | 0 - disabled 1 - active you can enable or disable the access to your account. if you set this to 0, no one can log into the account. | 1 | no | 0 |
builder_url | If you have a builder, here is the place to put the link so it will be available from the "Workflow Builder" section in the online. you must provide the valid builder url (builder login url) | 150 | no | https:// |
Important notice
Any other settings for the account can be changed from within the account settings inside the online. This updateAccount endpoint allows you to update builder_url , account status and account name which is not available for you inside the online account directly, and hence this API endpoint is the only way to update those parameters.
Response:
{
"status": "OK",
"reason": 1
"account_id": 8,
"server": "online,
"account_name": "account name",
"status": 1,
"builder_url": "https://builder.."
}
Response-Explain:
Parameter | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | OK or FAIL "OK" means the request was successful. "Fail" means error. | ||||||||||||||||||||||
account_id | The account ID you used | ||||||||||||||||||||||
server | The server subdomain that this inbox created on https://{{server}}.99digital.co.il | ||||||||||||||||||||||
account_name | The account name (this will show the new account name if you chose to update it, or the current account name if you didnt change this value) | ||||||||||||||||||||||
account_status | The account status 1 for active, 0 for suspended. (this will show the new account status if you chose to update it, or the current account status if you didnt change this value) | ||||||||||||||||||||||
builder_url | The builder URL link (this will show the new builder url if you chose to update it, or the current builder url if you didnt change this value) | ||||||||||||||||||||||
reason | 'reason' is the status explanation in case of FAIL
|