Errors of Customer Feed API

Prev Next

To assist in identifying and resolving issues, the Customer Feed API returns standard HTTP status codes along with detailed error responses. Below is a list of common status codes and their meanings

  • 200 OK: Successful GET, PUT, or DELETE request.

  • 201 Created: The resource creation succeeded.

  • 400 Bad Request: The request is malformed or missing parameters.

  • 401 Unauthorized: Authentication failed or API key is missing.

  • 404 Not Found: The requested resource does not exist.

  • 500 Internal Server Error: An error occurred on the server.

Error responses are returned as JSON objects containing detailed information about the issue. The structure is as follows:

{
  "type": "https://help.silentpush.com/v1/docs/en/228863e3-c6d0-4eb9-8611-a327ac670949?isPreview=true&isCategory=true&versionNumber=1",
  "title": "Api error",
  "status": 500,
  "detail": "We are unable to process your request at this time"
  "errors": [
    {
      "message": "Service offline"
    }
  ]
}

Field Parameters

  • type: A URL linking to detailed documentation about the error.

  • title: A brief description of the error type.

  • status: The HTTP status code associated with the error.

  • detail: A human-readable explanation of the error.

  • errors: An array of specific error messages providing additional context.

Note: Ensure that the type URL is valid and points to the correct documentation. If the provided URL is a placeholder, replace it with the accurate link.
Error messages in the errors array should be specific and actionable to help users.