Skip to content

Contribution

Overview

The Contribution Cloud API allows you to submit corrections for data in Melissa products.

You can use Contribution to:

  • Specify problem GeoPoints using Melissa Address Keys (MAKs).
  • Submit latitude and longitude corrections.
  • Provide an email for correction notifications.
  • Submit additional comments about the problem MAK.

Documentation

Useful Resources

Support Center

Download OpenAPI description
Languages
Servers
Contribution Server
http://contribution.melissadata.net/V4/WEB/

Change GeoPoint

Use this endpoint to submit problem GeoPoints with comments and corrections.

Operations

Add MAK

Use this endpoint to submit a request to add a new Melissa Address Key (MAK).

Operations

Change MAK

Use this endpoint to submit a request to change a Melissa Address Key (MAK).

Operations

Remove MAK

Use this endpoint to submit a request to remove a Melissa Address Key (MAK) from the system.

Operations

Add MIK

Use this endpoint to submit a request to add a new Melissa Identity Address Key (MIK).

Operations

Change MIK

Use this endpoint to submit a request to change a Melissa Identification Key (MIK).

Operations

Remove MIK

Use this endpoint to submit a request to remove a Melissa Identification Key (MIK) from the system.

Operations

Remove a MIK

Request

Uses HTTPS GET to accept one input record and returns the response in JSON format.

There are three ways to use this endpoint, depending on what request properties you send in.

Option 1

Required Fields:

  • id
  • act
  • mik

Option 2

Required Fields:

  • id
  • act
  • a1
  • a2
  • city
  • first
  • last
  • postal
  • state

Option 3

Required Fields:

  • id
  • act
  • a1
  • a2
  • city
  • full
  • postal
  • state
Query
tstring

Value passed through unchanged to the response for identification or any other purpose.

Example: t=Test
idany(password)required

The License Key issued by Melissa.

Example: id={REPLACE-WITH-YOUR-LICENSE-KEY}
actstringrequired

Required. This specifies the action to be taken.

Possible Values:

  • cpadelete - Erase personal data.
  • cpalimit - Object to personal data processing, including profiling and direct marketing.
  • cpaoptout - Withdraw any consent given for personal data processing.
  • delete
  • suppression
Example: act=delete
a1string

Required. A minimum address location for the contact.

a2string

The second address line.

citystring

Required. The city name.

firststring

Required. The parsed first name of an individual.

fullstring

Required. The full name of an individual.

laststring

Required. The parsed last name of an individual.

mikstringrequired

Required. A proprietary unique key associated with a person.

Example: mik=8008006245
postalstring

Required. The ZIP Code.

respondtostring

The email address to receive updates about the change request.

Example: respondto=youremail@melissadata.com
statestring

Required. The state name.

curl -i -X GET \
  'http://contribution.melissadata.net/V4/WEB/removeMIK?id={REPLACE-WITH-YOUR-LICENSE-KEY}&act=delete&mik=8008006245'

Responses

Successful response

Bodyapplication/json
Versionstring

The current service version number.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Contribution Result Codes.

TransmissionReferencestring

Serves as a unique request identifier.

Resultsstring

Comma delimited status, error codes, and change codes for the record. For more information, see Contribution Result Codes.

Messagestring

The response message for the request.

Response
application/json
{ "Version": "8.4.0.1026", "TransmissionReference": "Test", "TransmissionResults": "", "Results": "MS01", "Message": "Thank you for submitting your correction. All submissions will be reviewed and added. We cannot guarantee that all submissions will be reflected in our final products or when they will be added. Usual turn-around time is several months." }

Remove a MIK

Request

An HTTPS POST is issued with the "ContentType" header specifying the format of the request and the "Accept" header specifying the format of the response.

There are three ways to use this endpoint, depending on what request properties you send in.

Option 1

Required Fields:

  • CustomerID
  • Action
  • MelissaIdentificationKey

Option 2

Required Fields:

  • CustomerID
  • Action
  • AddressLine1
  • AddressLine2
  • City
  • FirstName
  • LastName
  • PostalCode
  • State

Option 3

Required Fields:

  • CustomerID
  • Action
  • AddressLine1
  • AddressLine2
  • City
  • FullName
  • PostalCode
  • State
Bodyapplication/jsonrequired
CustomerIDstringrequired

The License Key issued by Melissa.

TransmissionReferencestring

Optional. Value passed through unchanged to the response for identification or any other purpose.

Actionstringrequired

This specifies the action to be taken.

Possible Values:

  • cpadelete - Erase personal data.
  • cpalimit - Object to personal data processing, including profiling and direct marketing.
  • cpaoptout - Withdraw any consent given for personal data processing.
  • delete
  • suppression
AddressLine1string

A minimum address location for the contact.

AddressLine2string

The second address line.

Citystring

The city name.

FirstNamestring

The parsed first name of an individual.

FullNamestring

The full name of an individual.

LastNamestring

The parsed last name of an individual.

MelissaIdentityKeystring

A proprietary unique key identifier for an address.

PostalCodestring

The ZIP Code.

RespondToEmailstring

The email address to receive updates about the change request.

Statestring

The state name.

curl -i -X POST \
  http://contribution.melissadata.net/V4/WEB/removeMIK \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "TransmissionReference": "Test",
    "Action": "delete",
    "MelissaIdentityKey": "8008006245",
    "RespondToEmail": "youremail@melissadata.com"
  }'

Responses

Successful response

Bodyapplication/json
Versionstring

The current service version number.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Contribution Result Codes.

TransmissionReferencestring

Serves as a unique request identifier.

Resultsstring

Comma delimited status, error codes, and change codes for the record. For more information, see Contribution Result Codes.

Messagestring

The response message for the request.

Response
application/json
{ "Version": "8.4.0.1026", "TransmissionReference": "Test", "TransmissionResults": "", "Results": "MS01", "Message": "Thank you for submitting your correction. All submissions will be reviewed and added. We cannot guarantee that all submissions will be reflected in our final products or when they will be added. Usual turn-around time is several months." }