Errors

Prelude uses conventional HTTP statuses to indicate the success or failure of a request:

Codes in the 2xx range indicate success.
Codes in the 4xx range indicate an error that failed given the information provided (e.g. required parameter was omitted or an authentication failed).
Codes in the 5xx range indicate an error with Prelude’s servers (these are rare).

Codes

Below is a list of possible error codes, along with additional information about how to resolve them.

Code	Description
`account_invalid`	The provided customer UUID is invalid.
`bad_request`	The request was malformed.
`blocked_number`	The phone number is in the blocklist.
`duplicated_feedback_status`	Duplicated feedback status has found.
`internal_server_error`	An internal server error occurred.
`invalid_app_version`	The provided application version is invalid.
`invalid_auth_uuid`	The provided authentication UUID is invalid.
`invalid_device_id`	The provided device ID is invalid.
`invalid_device_model`	The provided device model is invalid.
`invalid_feedback_status`	The provided feedback status is invalid.
`invalid_line`	Prelude does not support this type of phone number.
`invalid_os_version`	The provided OS version is invalid.
`invalid_phone_number`	This is not a valid E.164 number.
`invalid_sender_id`	The provided Sender ID is invalid.
`invalid_template_id`	The provided template ID is invalid.
`negative_balance`	You have a negative balance.
`no_associated_auth_found`	The associated authentication was not found.
`suspended_account`	Your account has been suspended.
`unauthorized_sender_id`	The provided sender ID is not authorized to send messages.
`unsupported_region`	Prelude does not support this region yet.

code

enum<string>

A machine-readable code that describes the error.

Available options:

account_invalid,

app_realm_require_device_type,

bad_request,

blocked_number,

duplicated_feedback_status,

internal_server_error,

invalid_app_realm,

invalid_app_version,

invalid_auth_uuid,

invalid_device_id,

invalid_device_model,

invalid_feedback_status,

invalid_line,

invalid_os_version,

invalid_phone_number,

invalid_sender_id,

invalid_template_id,

negative_balance,

no_associated_auth_found,

suspended_account,

unauthorized_sender_id,

unsupported_app_realm_device_type,

unsupported_region

message

string

A human-readable message that describes the error.

doc_url

string

A link to the documentation that describes the error.