Sample response for recipients field is not present in request body
{
    "response_id": "wkskLzEMwM",
    "error": {
        "message": "Request_Body is mandatory. Kindly add request_body and the desired fields in the API payload.",
        "err_code": "BadRequest"
    }
}

Sample response for 'request_id' field is not present in request body
{
    "response_id": "jLcIFgNqiF",
    "error": {
        "message": "request_id - Field is required but value is None",
        "err_code": "InvalidFieldValue"
    }
}

Sample response for request body is not provided
{
    "response_id": "wkskLzEMwM",
    "error": {
        "message": "Request_Body is mandatory. Kindly add request_body and the desired fields in the API payload.",
        "err_code": "BadRequest"
    }
}

Sample response for invalid key in the request body
{
    "response_id": "gPrSPOPNtT",
    "error": {
        "message": "This API only supports 'Recipients', 'update_esp', 'esp' and 'request_id' as fields in the Request Body. Kindly remove other fields and try again",
        "err_code": "InvalidRequestBody "
    }
}

Sample response for more than 100 email addresses are provided in recipient array
{
    "response_id": "ofVaFGNZeU",
    "error": {
        "message": "Payload limit is set to 100",
        "err_code": "BadRequest"
    }
}

Sample response for when an integer or boolean is provided as recipient
{
    "response_id": "CNjLIXzCxP",
    "error": {
        "message": "Please provide input in a valid email address format (example@domain.com) as part of 'Recipients'.",
        "err_code": "InvalidInput"
    }
}

Sample response for empty recipients field
{
    "response_id": "VkJTiAOgxt",
    "error": {
        "message": "Add at least one email address as part of the 'Recipients'",
        "err_code": "InvalidInput"
    }
}

Sample response for incorrect values for the APP KEY/ HTTP auth header
{
    "response_id": "YNJhkZzfqt",
    "error": {
        "message": "MOE_APPKEY doesn't match the Username (APP_KEY) used in Basic Auth authorization.",
        "err_code": "HeaderMismatch"
    }
}

Sample response for when MOE-APPKEY header is not provided
{
    "response_id": "ptkMUbdHGl",
    "error": {
        "message": "MOE-APPKEY is missing in Header",
        "err_code": "HeaderMissing"
    }
}

Sample response for when username is not provided in the auth header
{
    "response_id": "RLuJLVlJap",
    "error": {
        "message": "Username (APP_KEY) is missing in the Basic Auth authorization.",
        "err_code": "AuthenticationMissing"
    }
}

Sample response for when password  is not provided in the auth header
{
    "response_id": "dKzDpSIiCG",
    "error": {
        "message": "Password (APP_SECRET) is missing in the Basic Auth authorization.",
        "err_code": "AuthenticationMissing"
    }
}

Sample response for when other authorization types are used instead of Basic Auth
{
  "response_id": "OULwnOIADe",
  "error": {
    "message": "Invalid authorization used. MoEngage only supports 'Basic Auth' authorization.",
    "err_code": "AuthenticationInvalid"
  }
}

Sample response for when API SECRET Key has not been set in the Dashboard
{
    "response_id": "YNJhkZzfqt",
    "error": {
        "message": "APP_SECRET is not set in the dashboard. Please login to the dashboard to set an API key in Settings.",
        "err_code": "AuthenticationMissing"
    }
}

Sample response for incorrect HTTP method usage
{
    "response_id": "GudkCOBkHT",
    "error": {
        "message": "This API only supports the POST method. Kindly update the method and retry again.",
        "err_code": "MethodNotAllowed"
    }
}

Sample response for unsupported media type
{
    "response_id": "quUXnIinLK",
    "error": {
        "message": "The header 'Content-Type' is missing. Kindly provide the header 'Content-Type' and set it as 'application/json'",
        "err_code": "HeaderMissing"
    }
}

Sample response for rate limit breach
{
    "response_id": "quUXnIinLK",
    "error": {
        "message": "Rate limit exceeded",
        "err_code": "TooManyRequests"
    }
}

Sample response for unknown errors
{
    "response_id": "quUXnIinLK",
    "error": {
        "message": "Please Contact Moengage Team",
        "err_code": "INTERNAL_SERVER_ERROR"
    }
}