LiquidFiles Documentation
LiquidFiles Documentation

Validate Recipients API

With the validate recipients API, you can validate recipients for the logged in user. This will validate the email addresses look like email address and that the user can send to these recipients. It can help creating user interfaces to make them more intuitive with being able to give feedback to the user without having to submit the request and wait for an error.

Request

Request Info
Info Value
Request URL /message/valid_recipients
Request VERB POST
Request Parameters
Parameter Type Description
recipients Array An array of recipients to validate.

The http response codes are 200 OK if all the recipients are valid, and 422 Unprocessable Entity if anything went wrong. In case of an error, there's also an error message with what went wrong.

Example using Curl

curl -X POST -H "Accept: application/json" \
   -H "Content-Type: application/json" \
   --user nkpIxMK9ucUUE7FvfNpdAf:x \
   -d '{"recipients":["someone@somewhere.com"]}' \
   https://liquidfiles.company.com/message/valid_recipients
        
{"message":{"status":"All Recipients are valid"}}