PUT /api/v202104/account/auditEnabled

Enables or disables bill auditing for a batch of accounts

SetAccountAuditExclusionV202104 Permissions: FlaggedItems (Manage)
Use this endpoint to bulk-enable or bulk-disable auditing on multiple accounts at once. When auditing is enabled for an account, bills entered against that account will be subject to audit checks. Returns the count of accounts selected and the count actually updated.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Request Body

AccountAuditEnable
Property Description Type
accountIds List of AccountIds to try and update Cannot be Empty Required (defined) integer[]
auditEnabled True to allow the accounts’ bills to be audited False to exclude the accounts’ bills from being audited Required (defined) boolean
Example Request Body application/json
{  "accountIds": [
    1
  ],  "auditEnabled": false
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

UpdateResult
Property Description Type
selected The total number of items that were targeted by the bulk operation Required (defined) integer (int32)
updated The number of items that were actually modified (excludes items that already matched the target state) Required (defined) integer (int32)
Example Response application/json
{  "selected": 1,  "updated": 1
}