Each response you receive from the API will also return an HTTP status code.
Scenarios
The table below will help you identify the reason why you are getting a certain response.
| HTTP status code | Title | Scenario |
|---|---|---|
| 200 | Success | You've submitted a successful request and a valid response was returned. Check out Metadata status codes and Attribute status codes for details. |
| 400 | Bad Request | You didn't specify the keys field. Try submitting another call and make sure the request body contains the keys field. Check out Search keys for details. |
| You've specified one or more invalid search keys. Try submitting another request and make sure you specify a valid search key for each dataset you use. Check out Search keys for details. | ||
| You didn't specify any search keys. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
| You didn't specify any search key for a dataset. Try submitting another request and make sure you specify a search key for each dataset you use. Check out Search keys for details. | ||
| You've specified multiple search keys for a dataset. Try submitting another request and make sure you only specify one search key per dataset. Check out Search keys for details. | ||
| You didn't specify the attributes field. Try submitting another cal and make sure the request body contains the attributes field. Check out Attributes for details. | ||
| You've specified one or more invalid attributes. Try submitting another request and make sure you specify valid attributes. Check out Attributes for details. | ||
| You didn't specify any attributes. Try submitting another request and make sure you specify at least one attribute for each dataset you use. Check out Attributes for details. | ||
| You've specified one or more empty attributes (e.g. " "). Try submitting another request and make sure you specify attribute names (e.g. "pin"). Check out Attributes for details. | ||
| You've specified an invalid country value. Try submitting another request and make sure you specify a valid country value. | ||
| You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
| You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
| You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
| You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
| You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
| 401 | Unauthorized | The authentication token you've provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. |
| The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
| The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
| The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
| 404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact support. |
| 406 | Not Acceptable | You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. Check out Supported data formats for details. |
| 408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact support. |
| 415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. Check out Supported data formats for details. |
| 429 | Too Many Requests | You've submitted too many requests. To protect all customers, your account has been temporarily throttled. Check out Rate limiting for details. |
| 500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact support. |
| 503 | Service Unavailable | The service is currently unavailable. You can check the API's uptime and downtime by going to the service status page. |
If you send a request to the API with the Add-Metadata header set to true, and the HTTP status code of the response is 200, the API will return a metadata-level status code, a message and a detail field.
| Code | Message | Detail |
|---|---|---|
| S200 | Success | All requested attributes retrieved. |
| S206 | Success | Some of the requested attributes retrieved. |
| S204 | No match | No records matching the specified keys. |
| S201 | Not authorized | Attributes not authorized. |
If you send a request to the API with the Add-Metadata header set to true, and the HTTP status code of the response is 200, the API will return a code and message for each attribute.
| Code | Message | Description |
|---|---|---|
| S200 | Match | Attribute retrieved successfully. |
| E404 | Not found | The requested attribute could not be found because there are no records matching the specified keys. |
| E401 | Not authorized | You are not authorized to use the requested attribute based on the token you have provided. |
