MailUp API
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

GetCredits method

Method parameters 

Returns the number of credits left in the administration console

  • string GetCredits(string accessKey)
  • accessKey: access key obtained using the Login method

Sample GetCredits response

<GetCreditsResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<credits>12500</credits> 
</GetCreditsResult> 

GetCreditsList

Method parameters 

Returns the number of credits left in the administration console, for a specific list or for all lists


string GetCreditsList(string accessKey, int idList)
accessKey: access key obtained using the Login method
idList: list identifier

  • Id idList <=0, returned data refer to all the lists
  • Id idList >0, returned data refer to the list indicated by the identifier


If error code=0, returned message will contain all the requested lists with the corresponding credits left
If error code<>0, returned message will contain a description of the error and the detail of the lists will be empty

Sample GetCreditsList response

<GetCreditsListsResult>
       <ErrorCode>0</ErrorCode>
       <ErrorDescription></ErrorDescription>
       <Lists>
             <List>
                    <ID>1</ID>
                    <Name>List N. 1</Name>
                    <Credit>0</Credit>
             </List>
             <List>
                    <ID>3</ID>
                    <Name>List N. 2</Name>
                    <Credit>0</Credit>
             </List>
             <List>
                    <ID>3</ID>
                    <Name>List N. 3</Name>
                    <Credit>4327</Credit>
             </List>
             <List>
                    <ID>4</ID>
                    <Name>List N. 4</Name>
                    <Credit>7095.677</Credit>
             </List>
</Lists>
</GetCreditsListsResult> 
  • No labels