Account Status Options
To aid the ability for our partners to control the account status. Sonian has introduced multiple account status options. The variables of the account statuses are:
Account Status Variables:
|
Status
|
API variable
|
Subscription Payable
|
Effects
|
Notes
|
|
Enabled
|
enabled
|
Yes
|
Account is fully active.
- Users can log on, Journaling and Indexing is occurring.
|
|
|
Disabled
|
disabled
|
No
|
Account is Disabled.
- No UI Access
- Acceptance of Journaling stops with a hard SMTP rejection (550)
- Date is marked that account was disabled
- Any and all system notifications are stopped
- notification submitted to account owner address
|
|
|
Suspended
|
suspended
|
Yes
|
Account is in a Suspended state
- No UI Access
- Continue to accept Journal Feed
- Notification submitted to 'account owner' address
|
|
|
Trial
|
trial
|
Yes
|
Account is in Trial
- Date noted of the start of Trial (date of original provisioning)
- Ability to define a Trial Period
- 14 days, 28 days
- Notifications submitted to the 'Account Owner' of the days left on the trial
- Notification submitted upon completion of the Trial
- after 14 days of the Trial completes, notification advising account will be deleted, permanently
- Non converted accounts to be deleted after 25 days
|
|
|
Deleted
|
deleted
|
No
|
Account is deleted.
- No UI Access
- Acceptance of Journaling stops with a hard SMTP rejection (550)
- Date is marked that account was disabled
- Any and all system notifications are stopped
- notification submitted to account owner email address
- the account can be recovered by Sonian within 25 days of deletion for a fee (after this time, Sonian cannot guarantee the possibility to recover)
|
|
Sample API calls to update the account status:
|
Syntax: -XPUT: <:partner-site-name>/api/v1/accounts/partners/<target_site_name> -d ‘{“status”: “<apply status>”}’
|
|
curl -XPUT \ -H "Content-Type: application/json" \ https://foodomain.com/support/api/v1/accounts/partners/supportdemo -u 'abc:123' \ -d \ '{ "status": "disabled" }'
|
Upon successful deployment of the above API calls, the response will return the account details, with the exception of ‘Deleted’ which will return the error “Not Found”, confirming that the account has been deleted.
Comments
0 comments
Please sign in to leave a comment.