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
.
To connect to this service you'll need to use one of these endpoints:
Protocol | URL |
---|---|
JSON |
JSON
https://webservices.data-8.co.uk/MPS/IsMailable.json |
OPEN API |
OPEN API
https://webservices.data-8.co.uk/swagger/MPS/swagger.json |
SOAP |
SOAP
https://webservices.data-8.co.uk/mps.asmx |
Name | Description |
---|---|
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 |
password | password
If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank. |
record | record
Contains the |
options | options
An array of options that control further details of how this method operates. See 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.
Name | Description |
---|---|
Common Options | |
ApplicationName |
ApplicationName
Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.
|
Name | Description |
---|---|
Status | Status
Indicates whether the method call was successful, or if some error occurred. If the |
Mailable | Mailable
|
Each request to this method consumes 1 MPS credit.
Request Format
{ "record": { "Name": { "Title": "Mr", "Forename": "John", "MiddleName": "", "Surname": "Smith" }, "Address": { "Lines": [ "Unit 2", "Venture Point", "Stanney Mill Road", "Chester", "CH2 4NE" ] } }, "options": {} }
Response Format
{ "Status": { "Success": true, "CreditsRemaining": 1000 }, "Mailable": null }
Depending on your chosen authentication method you will need to modify this request slightly:
API Key
https://webservices.data-8.co.uk/MPS/IsMailable.json?key=your-api-key
and do NOT include the
username
or password
properties in the request JSON document.
Username and Password
https://webservices.data-8.co.uk/MPS/IsMailable.json
and include
username
and password
properties in the request JSON document.Do not use for client-side requests!
JWT Token
https://webservices.data-8.co.uk/MPS/IsMailable.json
Include the JWT token in the request headers as:
Authorization: Bearer your-jwt-token
Parameter | Value |
---|---|
Parameters | |
record | |
Name | |
Name | Title
Forename
MiddleName
Surname
|
Address | |
Address | Lines |
Common Options | |
ApplicationName |
ApplicationName
|
Credits Remaining Today: 5 |