ban_acct_m Sample Call and Response
This example shows a call that sets an account's status to temporary ban and schedules a specific restoration date, based on the ban_acct_m method defined in the plsql_m_r73.yml release file.
This example covers a ban with a fixed restoration date and a documented reason code. It does not cover restoring the account after a fixed number of days instead of on a fixed date, or identifying the account by userid or client_acct_id.
Sample call
{
"rest_call": "ban_acct_m",
"output_format": "json",
"client_no": 4001,
"auth_key": "a1b2c3d4e5f6g7h8i9j0",
"account_no": 305567,
"date_to_restore": "2026-08-15",
"reason_cd": 2,
"comments": "Repeated unsolicited messages sent to other subscribers; account banned pending review."
}
The account_no field is used instead of its alternatives, userid and client_acct_id. The date_to_restore field specifies the exact date the account is restored; this example does not also supply days_to_restore, since the method description states that date_to_restore takes precedence and days_to_restore is ignored when both are present. The reason_cd value of 2 corresponds to "Spamming (communication policy violation)" in the method's defined enumeration; other values in that same enumeration cover general acceptable-use-policy violations, subscriber harassment, cheating, inappropriate language, and failure to follow administrator instructions.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of 0 together with an error_msg of "OK" indicates that the account was banned successfully with the restoration date recorded. This example leaves out error_details, since that field is marked nonpublic in the shared field definitions.