Response examples

Unsuccessful requests

Unsuccessful requests return an associative array with success being false and data being an instance of WP_Error with the error details.

E.g. a timeout error

Array
(
    [success] => 
    [data] => WP_Error Object
        (
            [errors] => Array
                (
                    [http_request_failed] => Array
                        (
                            [0] => cURL error 28: Operation timed out after 5000 milliseconds with 0 bytes received
                        )

                )
            [error_data] => Array()
            [additional_data:protected] => Array()
        )
)

Successful requests

Successful requests return an associative array with success being true and data being an array with code, body and headers properties. body contains the response from Kickbox.

Successful email verification response

Array
(
    [success] => 1
    [data] => Array
        (
            [code] => 200
            [body] => Array
                (
                    [result] => deliverable
                    [reason] => accepted_email
                    [role] => 
                    [free] => 
                    [disposable] => 
                    [accept_all] => 
                    [did_you_mean] => 
                    [sendex] => 1
                    [email] => deliverable@example.com
                    [user] => deliverable
                    [domain] => example.com
                    [success] => 1
                    [message] => You are using Kickbox's sandbox API, which is used to test your integration against mock results.
                )
            [headers] => Array()
        )
)

Successful batch verification response

Array
(
    [success] => 1
    [data] => Array
        (
            [code] => 200
            [body] => Array
                (
                    [id] => 42
                    [success] => 1
                    [message] => 
                )
            [headers] => Array()
        )
)

Successful batch verification status response

Array
(
    [success] => 1
    [data] => Array
        (
            [code] => 200
            [body] => Array
                (
                    [id] => 42
                    [name] => My batch filename
                    [created_at] => 2022-05-14T09:18:51.000Z
                    [status] => completed
                    [error] => 
                    [download_url] => download URL for batch results
                    [stats] => Array
                        (
                            [deliverable] => 0
                            [undeliverable] => 1
                            [risky] => 0
                            [unknown] => 0
                            [sendex] => 0
                            [addresses] => 1
                        )

                    [duration] => 6000
                    [success] => 1
                    [message] => 
                )
            [headers] => Array()
        )
)