Skip to the content

IsMailable

Checks if a person is registered on the MPS or not.

Live Demo

To connect to this service you'll need to use one of these endpoints:

JSON
Open API
SOAP

Description

Checks if the person given in the input record is registered with the MPS, and so does not wish to receive marketing by direct mail. If they are willing to receive direct mail, the service returns true. If not, the service returns false.

Credit Usage

Each request to this method consumes 1 MPS credit.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
record

record

Contains the Name and Address to check against the MPS

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
Mailable

Mailable

true if the person is not registered on the MPS and can therefore receive mail, or false if they are on the MPS

Live Demo

record

Name

Sorry, this parameter type is not currently supported in Live Demo

Address

Sorry, this parameter type is not currently supported in Live Demo
options
Name Value
Common Options

Sample Code