LiquidFiles Documentation
LiquidFiles Documentation

Validate Recipients API

Deprecation Notice

The XML API is only fully functional on LiquidFiles v2.x that is End of Life and End of Support.

This XML API has been deprecated in favour of the JSON API that's available in LiquidFiles v3.x onwards.

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 URL: /message/valid_recipients
Request VERB: POST
  Parameters:
    recipients                   # Array.   An array of recipients to validate
Response:

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 raw XML post

<?xml version="1.0" encoding="UTF-8"?>
<recipients type="array">
  <recipient>user1@company1.com</recipient>
  <recipient>user2@company2.com</recipient>
</recipients>