Skip to main content

HTTP Status Codes

The ProWebLook API uses conventional HTTP response codes to indicate the success or failure of a request.
CodeStatusDescription
200OKRequest succeeded.
202AcceptedBatch job submitted and is being processed.
400Bad RequestMissing or invalid parameters.
401UnauthorizedInvalid or missing API key.
402Payment RequiredInsufficient API credits for the requested service.
404Not FoundThe requested resource was not found (e.g., batch ID).
500Internal Server ErrorAn unexpected error occurred on the server.

Error Response Format

All errors return a JSON body with an error key:
{
  "error": "Description of the error."
}
Some errors include additional context fields:
{
  "error": "Insufficient WA API credits.",
  "required": 500,
  "available": 120
}

Common Errors

Cause: The api_key parameter is missing or does not match any registered user account.Resolution: Double-check your API key from the ProWebLook dashboard and ensure it is passed correctly as a query parameter or body field.
{ "error": "Invalid API key." }
Cause: Your credit balance for the requested service has been depleted.Resolution: Top up your credits from the ProWebLook dashboard. Use the Balance API to check your current balance before bulk operations.
{ "error": "Insufficient phone API credits." }
Cause: A required parameter is missing from the request.Resolution: Check the endpoint documentation and ensure all required fields are present.
{ "error": "PhoneNumber is missing in the request." }
Cause: More than 1,000 phone numbers were submitted in a single batch request.Resolution: Split your list into batches of 1,000 or fewer.
{
  "error": "Batch size exceeds the maximum allowed limit of 1000 numbers.",
  "submitted": 1500,
  "max_allowed": 1000
}
Cause: The batch_id does not exist or does not belong to the provided API key.Resolution: Ensure you are polling with the same api_key that submitted the batch, and that the batch_id is correct.
{ "error": "Batch not found or access denied." }