Skip to main content
Error Responses
D
Written by Dani Nabors
Updated over a week ago

In case of runtime error, API returns a standard fault message containing appropriate error codes (returned within fault code node) and error messages (returned within faultstring node).

For example, if a wrong or no longer valid API key is provided, the requested operation is denied and the following message is returned:

<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <SOAP-ENV:Fault>
            <faultcode>9</faultcode>
            <faultstring>Access denied, authentication failed</faultstring>
            <faultactor></faultactor>
            <detail></detail>
        </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

For example, if a valid API key is provided but API is not accessed from one of the IP addresses allowed for your account (lockdown addresses), requested operation is denied and the following SOAP XML message is returned — please note additional data available within the returned detail node, specifying the IP address from which API request was performed, and the list of allowed lockdown IP addresses for your account:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <SOAP-ENV:Fault>
            <faultcode>11</faultcode>
            <faultstring>Access denied, remote IP address not allowed</faultstring>
            <faultactor></faultactor>
            <detail>[Request: 12.3.4.5] [Lockdown: 12.3.4.1, 12.3.4.2, 12.3.4.3, 12.3.4.10]</detail>
        </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

In case requested API operation failed because of an already existing duplicate or deleted item, SOAP fault message contains the ID of an already existing item within the returned detail node.

For example, if the operation addCampaign() failed to be performed because a campaign with the specified name already exists within your account, the following SOAP XML message is returned:

<?xml version="1.0" encoding="UTF-8"?>
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <SOAP-ENV:Fault>
            <faultcode>8</faultcode>
            <faultstring>Item with the same name already existing
                         [Details: Campaign name already exists in online data]</faultstring>
            <faultactor></faultactor>
            <detail>276514</detail>
        </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Please note that returned SOAP fault messages usually contain additional human–readable information within the faultstring node, in addition to below-listed base messages, describing the actual reason why requested API operation failed to be performed.

Error Codes and Messages

A complete list of all possible error codes (faultcode note) and their respective base messages (faultstring node) is available below:

Error Code

Error Message

1

Requested operation failed

2

Requested operation failed, invalid parameter value received

3

Requested update operation failed

4

Item not found or not available for requested operation

5

Item not available, items parent deleted

6

Item not available for updating

7

Item not available for updating, item deleted

8

Item with the same name already existing

9

Access denied, authentication failed

10

Access denied, account not active

11

Access denied, remote IP address not allowed

12

Access throttled, performing requests too fast

996

Access temporarily denied, too many invalid requests received

997

System is currently busy, please try again later

998

Service temporarily unavailable due to maintenance

999

Service unavailable due to internal error

Did this answer your question?