Name
Updates the settings for account-expiration notification to intimate the user a few days in advance.
Availability
Acrobat Connect Pro Server 7
Description
Updates information about the settings for account-expiration notification (the notification given to users before an account expires). A user is notified x number of days before their account expires. This action simply updates the value of x.
Request URL
https://example.com/api/xml ?action=expiry-settings-update &account-id=Integer &session=String
Parameters
|
|
Type |
Required |
Description |
|
account-id |
BIGINT |
N |
The ID of the account. If you don’t provide an account ID, the information for the current account is updated. |
|
expiry-num-of-days |
Integer |
Y |
A user is notified this many days before their account expires. The default value is 30; possible values are 30, 60, and 90. For example, if the value of this parameter is 30, a user is notified 30 days before their account is due to expire. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> </results>
Response values
|
Element |
Attribute |
Type |
Description |
|
results |
|
Container |
All results the action returns. |
|
status |
|
Empty, with attributes |
The status of the response. |
|
|
code |
Allowed value |
A code indicating the response status (see status). |
Sample request
https://example.com/api/xml?action=expiry-settings-update&account-id=7&expiry-num-of-days=30
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok"/> </results>
See also