Overview
Returns email credit summary for an account in the database via an http form post.
Post Url
https://ReplaceWithYourWhiteLabelCRMDomain/api/2/GetEmailCreditSummary.aspx
- SSL is requred
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
apiusername | Yes | API User Name and password are assigned by AllClients | |
apipassword | Yes | API User Name and password are assigned by AllClients | |
accountid | Yes |
* An error will not result if Max Length is exceeded. Data will be trimmed to this length.
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<message>Success</message>
<accountid>15631</accountid>
<freecreditsbalance>2500</freecreditsbalance>
<paidcreditsbalance>1222</paidcreditsbalance>
<emailssentthismonth>125</emailssentthismonth>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>