Response Formats - OneNumber Documentation

Please note that all endpoints have similar error responses. Any endpoint that doesn’t follow the pattern shown on this page will contain the error response on it’s own page.

Successful Response Format containing data

{
    "statusCode": 201,
    "message": "Request processed successfully.",
    "data": "Custom data, depending on the endpoint"
}

Successful Response Format with no data

{
    "statusCode": 200,
    "message": "Request processed successfully."
}

Error Response Formats

Unsuccessful Request Error Response

{
    "statusCode": 300,
    "message": "Custom message containing the error details."
}

Failed Validation Error Response

{
    "statusCode": 301,
    "message": "Validation errors (or custom description)",
    "errors": "An array of the fields with the validation errors."
}

Resource not found Error Response

{
    "statusCode": 404,
    "message": "Custom message containing the error details."
}