Reference Guide

Introduction

Vault is a cloud-based DBMS. In addition to the functionality found in other cloud-based DBMS services, the Vault can provide scheduled processing using the same tools that Melissa offers on other platforms.

Base URL

https://vault.melissadata.net/

Vault parameters include path parameters. These path parameters become part of the URL path in the requests and should be used in the specific order.

New to Melissa Cloud Services?

We highly recommend first time users of our web services to review our Using Melissa Cloud APIs section. It will cover critical topics like:

• Licensing

• Rate Limiting

• IP Addresses

• Protocols and Usage

Endpoints

Alert

/V5/API/Alert/GetAlertInfo/{{tableName}}/{{alertName}}/{{primaryKey}}

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Alert/GetAlertInfo/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
ALERT	String. Alert name. [blank] will list all alerts. A regular expression may be used to query multiple alerts.
OPT	Set Options AllAlerts HiddenTable RegularExpression
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AllAlerts

Boolean. Sets return of information for alerts that have not been enabled or configured.

Parameter	Description
False	Default Do not return information.
True	Return information.

HiddenTable

Boolean. Sets inclusion of hidden tables in the search results.

Parameter	Description
False	Default Do not include hidden tables.
True	Include hidden tables.

RegularExpression

Boolean. Sets regular expression use for table name and alert name search.

Parameter	Description
False	Default Do not use regular expressions.
True	Use regular expressions.

Response

{
  "TransmissionResults": "",
  "Tables": [
    {
      "TableName": "HomesData",
      "Alerts": [
        {
          "Status": "VE04",
          "AlertType": "ChangeOfAddress",
          "AlertName": "ChangeOfAddress",
          "AlertDescription": "Update addresses of people who have changed their address",
          "InputColumnMappings": [
            {
              "ColumnType": "FirstName",
              "ColumnName": "FirstName"
            }
          ],
          "InputColumnRequirements": [
            {
              "Rule": "(City && State) || PostalCode",
              "ErrorMessage": "City and state or postal code are required"
            }
          ],
          "Schedule": "Default",
          "HRSchedule": "Default",
          "Channel": {
            "Channel": "WebHook",
            "Url": "https://example.com/recordAlert/smartMover/%@record%",
            "Method": "GET",
            "Headers": [
              "…"
            ],
            "Body": "",
            "Email": "address@example.com",
            "Schedule": "Immediate",
            "HRSchedule": "Immediate"
          }
        }
      ]
    }
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Alert/SelectRecords/{{tableName}}/{{alertName}}/{{primaryKey}}

Select records that have been modified through an alert.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Alert/SelectRecords/HomesData/AddressUpdate/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
OPT	Set Options CountAllRecords IncludeNulls JoinCondition KeysAre@Records TransactionOrder
ORDER	String. T-SQL representation of ORDER BY clause.
PGSIZE	Integer (32bit). Number of records to output per paged request.
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.
{{alertName}}	String. A comma-separated list of alert(s) to return transactions on.
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CountAllRecords

Boolean. Sets if TotalSelectRecords will contain a count of all records that satisfy the specified query, otherwise it is set to 0.

Parameter	Description
False	Default. TotalSelectRecords is set to 0.
True	TotalSelectRecords will contain a count of all records for the query.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

Response

{
  "TransmissionResults": "",
  "Records": [
    [
      {
        "@record": 1,
        "FirstName": "John",
        "LastName": "Smith",
        "Address": "10 Smith St",
        "City": "Springfield",
        "State": "CA",
        "PostalCode": "99876-1024",
        "@transactionDate": "2022-10-21T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "Address,City,PostalCode"
      },
      {
        "@record": 1,
        "FirstName": "John",
        "LastName": "Smith",
        "Address": "123 Main St Apt 1",
        "City": "Anytown",
        "State": "CA",
        "PostalCode": "12345",
        "@transactionDate": "2021-03-15T00:00:00",
        "@transactionType": "Insert",
        "@transactionSubUser": 1,
        "@transactionColumns": "FirstName,LastName,Address,City,State,PostalCode"
      }
    ],
    [
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Smith-Doe",
        "Address": "10 Smith St",
        "City": "Springfield",
        "State": "CA",
        "PostalCode": "99876-1024",
        "@transactionDate": "2022-10-21T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "LastName,Address,City,PostalCode"
      },
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Doe",
        "Address": "123 Main St Apt 1",
        "City": "Anytown",
        "State": "CA",
        "PostalCode": "12345",
        "@transactionDate": "2018-03-18T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "Address,City,State,PostalCode"
      },
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Doe",
        "Address": "15 University Ave",
        "City": "Dartmouth",
        "State": "NH",
        "PostalCode": "10028",
        "@transactionDate": "2015-02-22T00:00:00",
        "@transactionType": "Insert",
        "@transactionSubUser": 1,
        "@transactionColumns": "FirstName,LastName,Address,City,State,PostalCode"
      }
    ]
  ],
  "TotalSelectRecords": 0,
  "TransmissionReference": "TEST"
}

/V5/API/Alert/SelectRecordsFTP/{{tableName}}/{{alertName}}/{{primaryKey}}

Select records that have been modified through an alert for download.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Alert/SelectRecordsFTP/HomesData/AddressUpdate/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls JoinCondition KeysAre@Records OverwriteOutputFile TransactionOrder TransactionStyle
ORDER	String. T-SQL representation of ORDER BY clause.
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Body Parameters
PrimaryKeyValues	Array of Strings or Null. List of primary key values of records to return.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.
{{alertName}}	String. A comma-separated list of alert(s) to return transactions on.
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited file format.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

TransactionStyle

String. Sets the transaction layout.

Parameter	Description
Flat	Default. Transactions are output as a simple list.
Hierarchical	Transactions are output in a tiered manner. Delimited files add a column with a * to indicate the first transaction in a set. Excel files group transactions and color changed data.
Delta	A single record is output for each changed record, containing its current value.

Response

{
  "TransmissionResults": "",
  "FileName": "50140c99-c874-427b-80db-492f360fe663",
  "Url": "ftp://vault.melissadata.net/50140c99-c874-427b-80db-492f360fe663",
  "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46",
  "TransmissionReference": "TEST"
}

/V5/API/Alert/SelectRecordsFTPAsync/{{tableName}}/{{alertName}}/{{primaryKey}}

Select records that have been modified through an alert for download asychronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Alert/SelectRecordsFTPAsync/HomesData/AddressUpdate/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls JoinCondition KeysAre@Records OverwriteOutputFile TransactionOrder TransactionStyle
ORDER	String. T-SQL representation of ORDER BY clause.
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Body Parameters
PrimaryKeyValues	Array of Strings or Null. List of primary key values of records to return.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.
{{alertName}}	String. A comma-separated list of alert(s) to return transactions on.
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited file format.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

TransactionStyle

String. Sets the transaction layout.

Parameter	Description
Flat	Default. Transactions are output as a simple list.
Hierarchical	Transactions are output in a tiered manner. Delimited files add a column with a * to indicate the first transaction in a set. Excel files group transactions and color changed data.
Delta	A single record is output for each changed record, containing its current value.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

Async

/V5/API/Async/GetProcessStatus/{{processId}}

Retrieve current status of asynchronous process.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Async/GetProcessStatus/8716632a-a32a-4c09-a3f6-589b8af6eeae \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{processId}}	String. Identifier returned by Async function.

Response

{
  "TransmissionResults": "",
  "Created": "2022-09-01T09:00:00",
  "Completed": "2022-09-01T09:10:00",
  "Progress": 100,
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Async/ClearProcessStatus/{{processId}}

Clear status of asynchronous process.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PUT \
  --url https://vault.melissadata.net/V5/API/Async/ClearProcessStatus/8716632a-a32a-4c09-a3f6-589b8af6eeae \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{processId}}	String. Identifier returned by Async function.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

File

/V5/API/File/DeleteFile/{{fileName}}

Delete an upload/download file.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/File/DeleteFile/ExcelSheet1.xlsx \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{fileName}}	String. Specify target file name.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

/V5/API/File/DownloadFile/{{fileName}}

Download a file.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/File/DownloadFile/ExcelSheet1.xlsx \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{fileName}}	String. Specify target file name.

Response

...

/V5/API/File/GetFileInfo/{{fileName}}

Get information and sample records from an upload/download file.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/File/GetFileInfo/ImportSheets.zip \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options Delimiter LimitRows TrimWhitespace
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to examine.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{fileName}}	String. Specify target file name.

Notes

It may be necessary to call GetFileInfo several times to build a full request. For example, if the file is a compressed file, the first call would return with FileFormat set to Compressed, and a list of the compressed files in CompressedFiles.

A second call would specify which file to analyze in the compressed file parameter. If the compressed file is an Excel spreadsheet, this call would return FileFormat as Excel, and Sheets would contain a list of the sheets in the Excel file.

Finally, a third call would be made with the input file, compressed file and sheet name parameters specified. This call would finally return SampleData and Records.

Regardless of FileFormat or Delimiter, the records returned in SampleData will be tab-delimited.

By default, GetFileInfo will analyze the specified file and determine the file’s format (Delimited, JSON or Excel) and, in the case of the Delimited format, the column delimiter. However, this can be overridden by specifying FORMAT and the Delimiter OPT property.

Options

Delimiter

String. Sets the delimiter for the file format.

Parameter	Description
[Null]	Default. No delimiter will be used.

LimitRows

Integer. Set the limit for the number of rows to return.

Parameter	Description
10	Default. 10 rows will be returned.
[#]	# of rows to return.

TrimWhitespace

Boolean. Sets if the leading and trailing spaces will be trimmed from text data.

Parameter	Description
False	Spaces will NOT be trimmed.
True	Default. Spaces WILL be trimmed.

Response

{
  "TransmissionResults": "",
  "FileFormat": "Delimited",
  "Encoding": "ASCII",
  "Delimiter": "Comma",
  "SampleData": [
    [
      "John",
      "Smith",
      "123 Main St",
      "Anytown",
      "CA",
      "12345"
    ],
    [
      "Jane",
      "Doe",
      "456 Main St",
      "Anytown",
      "CA",
      "12345"
    ]
  ],
  "SampleSchema": [
    {
      "ColumnName": "FirstName",
      "ColumnType": "FirstName",
      "Size": 20
    },
    {
      "ColumnName": "LastName",
      "ColumnType": "LastName",
      "Size": 20
    },
    {
      "ColumnName": "Address",
      "ColumnType": "Address",
      "Size": 40
    },
    {
      "ColumnName": "City",
      "ColumnType": "City",
      "Size": 30
    },
    {
      "ColumnName": "State",
      "ColumnType": "State",
      "Size": 2
    },
    {
      "ColumnName": "PostalCode",
      "ColumnType": "PostalCode",
      "Size": 10
    }
  ],
  "FirstRowSchema": false,
  "Count": 12356,
  "TransmissionReference": "TEST"
}

/V5/API/File/ListFiles/{{fileName}}

Retrieve list of upload/download files.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url 'https://vault.melissadata.net/V5/API/File/ListFiles/.*/.xlsx' \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{fileName}}	String. Specify target file name.

Notes

If PGSIZE and/or PGNO are not specified, the default page size is 1000 and the default page number is 0.

Response

{
  "TransmissionResults": "",
  "Files": [
    {
      "FileName": "ExcelSheet1.xlsx",
      "Created": "2022-04-01T09:05:01",
      "LastAccessed": "2022-04-01T11:05:03",
      "Size": 12356,
      "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46"
    }
  ],
  "TotalFiles": 12,
  "TransmissionReference": "TEST"
}

/V5/API/File/UploadFile/{{fileName}}

Upload a file.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request POST \
  --url https://vault.melissadata.net/V5/API/File/UploadFile/ExcelSheet1.xlsx \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: multipart/form-data' \
  --form Options=OverwriteExisting \
  --form TransmissionReference=TEST \
  --form 'List`1[0]=undefined'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options OverwriteExisting
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Body Parameters
{{customerId}}	String. The License Key issued by Melissa (Encrypted).
FILES	Array of Strings. An array of file(s) to upload.
OPT	Options.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{fileName}}	String. Specify target file name.

Options

OverwriteExisting

Boolean. Sets if the upload file will overwrite a file if it already exists.

Parameter	Description
False	Default. The upload file will NOT overwrite an existing file.
True	The upload file WILL overwrite an existing file.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

Message

/V5/API/Message/GetMessages

Get a user’s messages.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Message/GetMessages \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options CountAllRecords IncludeReadMessages IncludeStaleMessages Order
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CountAllRecords

Boolean. Sets if the TotalMessages field will contain a count of all messages or not. When a count is not included, TotalMessages will return 0.

Parameter	Description
False	Default. Message count disabled. TotalMessages will return 0.
True	TotalMessages will return a count of all messages.

IncludeReadMessages

Boolean. Sets inclusion of read messages in the response.

Parameter	Description
False	Default. Read messages are NOT included.
True	Read messages ARE included.

IncludeStaleMessages

Boolean. Sets inclusion of stale messages in the response.

Stale messages refer to tables, alerts or jobs that have since been modified since the message was sent. Information contained in the message may not longer be relevant due to those changes.

Parameter	Description
False	Default. Stale messages are NOT included.
True	Stale messages ARE included.

Order

String. Sets the order of messages in the response.

Parameter	Description
Newest	Messages orderd from newest to oldest.
Oldest	Default. Messages ordered from oldest to newest.

Response

{
  "TransmissionResults": "",
  "Messages": [
    {
      "MessageID": 13,
      "Status": "",
      "Sender": "AddressUpdate",
      "Subject": "Processing of HomesData table completed",
      "Message": "85 addresses updated",
      "TableName": "HomesData",
      "ProcessName": "AddressUpdate",
      "ProcessType": "AddressUpdate",
      "Link": "https://vault.melissa.com/tables/HomesData/alert/",
      "DateAdded": "2022-10-21T00:00:00",
      "DateRead": "2022-10-22T00:00:00"
    }
  ],
  "TotalMessages": 12,
  "TransmissionReference": "TEST"
}

/V5/API/Message/SetMessageStatus

Set the user message(s) status.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PATCH \
  --url https://vault.melissadata.net/V5/API/Message/SetMessageStatus \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "MessageStatuses": [
    {
      "MessageID": 13,
      "Status": ""
    }
  ],
  "TransmissionReference": "TEST"
}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Body Parameters
MessageStatuses	Array of Objects or Null. List of messages to modify.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

Record

/V5/API/Record/DeleteRecords/{{tableName}}/{{primaryKey}}

Delete records from a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/Record/DeleteRecords/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options AbortOnAnyError AbortOnErrors KeysAre@Records
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be deleted, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but deletion by @record id desired.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be deleted.

Parameter	Description
False	Default. Matching records will not be deleted.
True	Matching records will be deleted.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Record/InsertRecords/{tableName}

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request POST \
  --url https://vault.melissadata.net/V5/API/Record/InsertRecords/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options AbortOnAnyError AbortOnErrors CreateTable Delimiter ReplaceExistingRecords TransactionType UpdateExistingRecords
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

This function offers three different ways of providing insert data:

• Dictionary-based - Records are contained in a List<Record>, where Record is a JSON representation of the table’s schema.

• Delimited Records - Records are contained in a List<string>, where each list element is a delimited record.

• Key/Value Pairs - Records are contained in a List<List<InsertRecord>>, where InsertRecord is a key/value pair. This interface is very similar to how requests are done in the HubSpot API.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

CreateTable

Boolean. Sets if non-schema table will be created if the specified table doesn’t exist.

Parameter	Description
False	Default. A non-schema table will NOT be created.
True	A non-schema table WILL be created.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

ReplaceExistingRecords

Boolean. Sets if an existing record having the same primary key will be entirely replaced with the input record.

Parameter	Description
False	Default. An existing record will NOT be replaced.
True	An existing record WILL be replaced.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

UpdateExistingRecords

Boolean. Sets if an existing record having the same primary key will be updated with the input record.

Parameter	Description
False	Default. A matching existing record will NOT be updated.
True	A matching existing record WILL be updated with the input record.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Record/SearchRecords/{{tableName}}

Search for records in a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SearchRecords/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
OPT	Set Options CountAllRecords IncludeNulls OrderByCloseness
ORDER	String. T-SQL representation of ORDER BY clause.
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
SEARCH	String. The word or phrase to search for.
SEARCHCOLS	String. A comma-separated (,) list of columns to search.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CountAllRecords

Boolean. Sets if TotalSelectRecords will contain a count of all records that satisfy the specified query, otherwise it is set to 0.

Parameter	Description
False	Default. TotalSelectRecords is set to 0.
True	TotalSelectRecords will contain a count of all records for the query.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

OrderByCloseness

Boolean. Sets if the result records will be ordered by how closely they match the requested search string.

Parameter	Description
False	Default. Result records will NOT be ordered.
True	Result records WILL be ordered by closeness.

Response

{
  "TransmissionResults": "",
  "Records": [
    {
      "FirstName": "John",
      "LastName": "Smith",
      "Address": "123 Main St",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    },
    {
      "FirstName": "Jane",
      "LastName": "Doe",
      "Address": "456 Main St",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    }
  ],
  "TotalSearchRecords": 2,
  "TransmissionReference": "TEST"
}

/V5/API/Record/SelectRecords/{{tableName}}/{{primaryKey}}

Select records from a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SelectRecords/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
OPT	Set Options CountAllRecords IncludeNulls JoinCondition KeysAre@Records
ORDER	String. T-SQL representation of ORDER BY clause.
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CountAllRecords

Boolean. Sets if TotalSelectRecords will contain a count of all records that satisfy the specified query, otherwise it is set to 0.

Parameter	Description
False	Default. TotalSelectRecords is set to 0.
True	TotalSelectRecords will contain a count of all records for the query.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

Response

{
  "TransmissionResults": "",
  "Records": [
    {
      "FirstName": "John",
      "LastName": "Smith",
      "Address": "123 Main St",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    },
    {
      "FirstName": "Jane",
      "LastName": "Doe",
      "Address": "456 Main St",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    }
  ],
  "TotalSelectRecords": 2,
  "TransmissionReference": "TEST"
}

/V5/API/Record/UpdateRecords/{{tableName}}

Update existing records in a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PATCH \
  --url https://vault.melissadata.net/V5/API/Record/UpdateRecords/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "Action": "Update",
  "Records": [
    {
      "@record": 10,
      "FirstName": "John",
      "LastName": "Smith",
      "Address": "123 Main St Apt 1",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    },
    {
      "@record": 11,
      "FirstName": "Jane",
      "LastName": "Smith-Doe",
      "Address": "123 Main St Apt 1",
      "City": "Anytown",
      "State": "CA",
      "PostalCode": "12345"
    }
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
ACT	String. The action to perform: Update, Replace or Delete.
OPT	Set Options AbortOnAnyError AbortOnErrors TransactionType
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

Update records are identified by the primary key, which must be specified for each record in Records. If the table does not have a primary key, the records’ @record value should be used. If both are present in Records, @record will be used.

Actions

• Update - Existing data will be updated with data in Records. Column data in the existing record that does not exist in Records will remain.

• Replace - Existing data will be replaced in it’s entirety with the data in Records. Column data in the existing record that does not exist in Records will be removed.

• Delete - The specified columns in Records will be removed from the existing data (the values in Records are ignored). Columns in the existing record that do not exist in Records will remain.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

Record (FTP)

/V5/API/Record/DeleteRecordsFTP/{{tableName}}

Delete existing records from data in an uploaded file.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/Record/DeleteRecordsFTP/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors DeleteInputFile Delimiter Encoding FirstRowSchema KeysAre@Records LimitRows SkipRows
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but deletion by @record is desired.

Data can be formatted:

• Delimited

• JSON (one row of JSON per record or as a giant List)

• Excel

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be deleted.

Parameter	Description
False	Default. Matching records will not be deleted.
True	Matching records will be deleted.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Record/InsertRecordsFTP/{tableName}

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request POST \
  --url https://vault.melissadata.net/V5/API/Record/InsertRecordsFTP/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors CreateTable DeleteInputFile Delimiter Encoding FirstRowSchema LimitRows ReplaceExistingRecords SkipRows TransactionType TrimWhiteSpace UpdateExistingRecords
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

• Compressed files must have one of the following extensions: 7z, bz2, gz, gzip, lz, rar, tar or zip.

• Excel files must have one of the following extensions: xls or xlsx.

• When the upload file is a compressed file archive and the compressed file name is not specified, then the archive must contain only a single file -or- a file having the same name as the table name. Otherwise, an error is returned.

• When the upload file is an Excel spreadsheet and the sheet name is not specified, then the spreadsheet must contain only a single sheet containing data -or- a sheet having the same name as the table name. Otherwise, an error is returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

CreateTable

Boolean. Sets if non-schema table will be created if the specified table doesn’t exist.

Parameter	Description
False	Default. A non-schema table will NOT be created.
True	A non-schema table WILL be created.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

ReplaceExistingRecords

Boolean. Sets if an existing record having the same primary key will be entirely replaced with the input record.

Parameter	Description
False	Default. An existing record will NOT be replaced.
True	An existing record WILL be replaced.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

TrimWhiteSpace

Integer. Sets if the leading and trailing spaces will be trimmed from text data.

Parameter	Description
False	Leading and trailing spaces will NOT be trimmed.
True	Default. Leading and trailing spaces WILL be trimmed.

UpdateExistingRecords

Boolean. Sets if an existing record having the same primary key will be updated with the input record.

Parameter	Description
False	Default. A matching existing record will NOT be updated.
True	A matching existing record WILL be updated with the input record.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Record/SearchRecordsFTP/{{tableName}}

Search records in a table for download.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SearchRecordsFTP/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls OrderByCloseness OverwriteOutputFile
ORDER	String. T-SQL representation of ORDER BY clause.
SEARCH	String. The word or phrase to search for.
SEARCHCOLS	String. A comma-separated (,) list of columns to search.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

OrderByCloseness

Boolean. Sets if the result records will be ordered by how closely they match the requested search string.

Parameter	Description
False	Default. Result records will NOT be ordered.
True	Result records WILL be ordered by closeness.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

Response

{
  "TransmissionResults": "",
  "FileName": "50140c99-c874-427b-80db-492f360fe663",
  "Url": "ftp://vault.melissadata.net/50140c99-c874-427b-80db-492f360fe663",
  "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46",
  "TransmissionReference": "TEST"
}

/V5/API/Record/SelectRecordsFTP/{{tableName}}/{{primaryKey}}

Select records from a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SelectRecordsFTP/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls JoinCondition KeysAre@Records OverwriteOutputFile
ORDER	String. T-SQL representation of ORDER BY clause.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

Response

{
  "TransmissionResults": "",
  "FileName": "50140c99-c874-427b-80db-492f360fe663",
  "Url": "ftp://vault.melissadata.net/50140c99-c874-427b-80db-492f360fe663",
  "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46",
  "TransmissionReference": "TEST"
}

/V5/API/Record/UpdateRecordsFTP/{{tableName}}

Update existing records in a table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PATCH \
  --url https://vault.melissadata.net/V5/API/Record/UpdateRecordsFTP/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
ACT	String. The action to perform: Update, Replace or Delete.
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors DeleteInputFile Delimiter Encoding FirstRowSchema LimitRows SkipRows TransactionType TrimWhiteSpace
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

Update records are identified by the primary key, which must be specified for each record. If the table does not have a primary key, the records’ @record value should be used. If both are present, @record will be used.

Data can be formatted:

• Delimited

• JSON (one row of JSON per record or as a giant List)

• Excel

Actions

• Update - Existing data will be updated with data in the upload file. Column data in the existing record that does not exist in the upload file will remain.

• Replace - Existing data will be replaced in it’s entirety with the data in the upload file. Column data in the existing record that does not exist in the upload file will be removed.

• Delete - The specified columns in the upload file will be removed from the existing data (the values are ignored). Columns in the existing record that do not exist in the upload file will remain.

• Compressed files must have one of the following extensions: 7z, bz2, gz, gzip, lz, rar, tar or zip.

• Excel files must have one of the following extensions: xls or xlsx.

• When the upload file is a compressed file archive and the compressed file name is not specified, then the archive must contain only a single file -or- a file having the same name as the table name. Otherwise, an error is returned.

• When the upload file is an Excel spreadsheet and the sheet name is not specified, then the spreadsheet must contain only a single sheet containing data -or- a sheet having the same name as the table name. Otherwise, an error is returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

TrimWhiteSpace

Integer. Sets if the leading and trailing spaces will be trimmed from text data.

Parameter	Description
False	Leading and trailing spaces will NOT be trimmed.
True	Default. Leading and trailing spaces WILL be trimmed.

Response

{
  "TransmissionResults": "",
  "Results": [
    "",
    ""
  ],
  "TransmissionReference": "TEST"
}

Record (FTP Async)

/V5/API/Record/DeleteRecordsFTPAsync/{{tableName}}

Delete existing records from data in an uploaded file asynchronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/Record/DeleteRecordsFTPAsync/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors DeleteInputFile Delimiter Encoding FirstRowSchema KeysAre@Records LimitRows SkipRows
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but deletion by @record is desired.

Data can be formatted:

• Delimited

• JSON (one row of JSON per record or as a giant List)

• Excel

• Compressed files must have one of the following extensions: 7z, bz2, gz, gzip, lz, rar, tar or zip.

• Excel files must have one of the following extensions: xls or xlsx.

• When the upload file is a compressed file archive and the compressed file name is not specified, then the archive must contain only a single file -or- a file having the same name as the table name. Otherwise, an error is returned.

• When the upload file is an Excel spreadsheet and the sheet name is not specified, then the spreadsheet must contain only a single sheet containing data -or- a sheet having the same name as the table name. Otherwise, an error is returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be deleted.

Parameter	Description
False	Default. Matching records will not be deleted.
True	Matching records will be deleted.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

/V5/API/Record/InsertRecordsFTPAsync/{tableName}

Insert records from an uploaded file asynchronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request POST \
  --url https://vault.melissadata.net/V5/API/Record/InsertRecordsFTPAsync/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors CreateTable DeleteInputFile Delimiter Encoding FirstRowSchema LimitRows ReplaceExistingRecords SkipRows TransactionType TrimWhiteSpace UpdateExistingRecords
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

Data can be formatted:

• Delimited

• JSON (one row of JSON per record or as a giant List)

• Excel

• Compressed files must have one of the following extensions: 7z, bz2, gz, gzip, lz, rar, tar or zip.

• Excel files must have one of the following extensions: xls or xlsx.

• When the upload file is a compressed file archive and the compressed file name is not specified, then the archive must contain only a single file -or- a file having the same name as the table name. Otherwise, an error is returned.

• When the upload file is an Excel spreadsheet and the sheet name is not specified, then the spreadsheet must contain only a single sheet containing data -or- a sheet having the same name as the table name. Otherwise, an error is returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

CreateTable

Boolean. Sets if non-schema table will be created if the specified table doesn’t exist.

Parameter	Description
False	Default. A non-schema table will NOT be created.
True	A non-schema table WILL be created.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

ReplaceExistingRecords

Boolean. Sets if an existing record having the same primary key will be entirely replaced with the input record.

Parameter	Description
False	Default. An existing record will NOT be replaced.
True	An existing record WILL be replaced.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

TrimWhiteSpace

Integer. Sets if the leading and trailing spaces will be trimmed from text data.

Parameter	Description
False	Leading and trailing spaces will NOT be trimmed.
True	Default. Leading and trailing spaces WILL be trimmed.

UpdateExistingRecords

Boolean. Sets if an existing record having the same primary key will be updated with the input record.

Parameter	Description
False	Default. A matching existing record will NOT be updated.
True	A matching existing record WILL be updated with the input record.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

/V5/API/Record/SearchRecordsFTPAsync/{{tableName}}

Search records in a table for download asynchronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SearchRecordsFTPAsync/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls OrderByCloseness OverwriteOutputFile
ORDER	String. T-SQL representation of ORDER BY clause.
SEARCH	String. The word or phrase to search for.
SEARCHCOLS	String. A comma-separated (,) list of columns to search.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

OrderByCloseness

Boolean. Sets if the result records will be ordered by how closely they match the requested search string.

Parameter	Description
False	Default. Result records will NOT be ordered.
True	Result records WILL be ordered by closeness.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

/V5/API/Record/SelectRecordsFTPAsync/{{tableName}}/{{primaryKey}}

Select records from a table for download asynchronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Record/SelectRecordsFTPAsync/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "PrimaryKeyValues": [
    "8008006245",
    "5089617240"
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema IncludeNulls JoinCondition KeysAre@Records OverwriteOutputFile
ORDER	String. T-SQL representation of ORDER BY clause.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

/V5/API/Record/UpdateRecordsFTPAsync/{{tableName}}

Update existing records from data in an uploaded file asynchronously​.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PATCH \
  --url https://vault.melissadata.net/V5/API/Record/UpdateRecordsFTPAsync/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
ACT	String. The action to perform: Update, Replace or Delete.
CFILE	String. If the specified file is a compressed file, the name of the compressed file to examine.
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options AbortOnAnyError AbortOnErrors DeleteInputFile Delimiter Encoding FirstRowSchema LimitRows SkipRows TransactionType TrimWhiteSpace
SHA	String. SHA-256 checksum of the file to examine.
SHEET	String. For Excel files, the name of the sheet to import.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

Update records are identified by the primary key, which must be specified for each record. If the table does not have a primary key, the records’ @record value should be used. If both are present, @record will be used.

Data can be formatted:

• Delimited

• JSON (one row of JSON per record or as a giant List)

• Excel

Actions

• Update - Existing data will be updated with data in the upload file. Column data in the existing record that does not exist in the upload file will remain.

• Replace - Existing data will be replaced in it’s entirety with the data in the upload file. Column data in the existing record that does not exist in the upload file will be removed.

• Delete - The specified columns in the upload file will be removed from the existing data (the values are ignored). Columns in the existing record that do not exist in the upload file will remain.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

AbortOnAnyError

Boolean. Sets if a data or rule issue on any record will cause the entire set of records to not be updated.

Parameter	Description
False	Data or rule issues will not prevent record updates.
True	Default. Any data or rule issue will prevent all records updates.

AbortOnErrors

String. Only abort if any record reports a result code in the specified (comma-delimited) list of result codes.

Parameter	Description
[blank]	Default. No result codes specified.
{{result code}}	Abort if a returned result code matches.

DeleteInputFile

Boolean. Sets if the upload file will be deleted after a successful operation.

Parameter	Description
False	Default. The upload file will NOT be deleted.
True	The upload file WILL be deleted.

Delimiter

String. Sets the delimiter used in the delimited fields.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

LimitRows

Integer. Sets the import to be limited by the specified number of rows. 0 means all rows.

Parameter	Description
0	Default. All rows will be imported.
{{#}}	Only the specificed number of rows will be imported.

SkipRows

Integer. Sets the number of rows to skip at the top of the input file.

Parameter	Description
0	Default. No rows will be skipped.
{{#}}	The specified number of rows will be skipped.

TransactionType

String. Sets the transaction type on the transaction record of the temporal table.

Parameter	Description
Insert	Default. The recorded transaction type will be Insert.
Update	The recorded transaction type will be Update.

TrimWhiteSpace

Integer. Sets if the leading and trailing spaces will be trimmed from text data.

Parameter	Description
False	Leading and trailing spaces will NOT be trimmed.
True	Default. Leading and trailing spaces WILL be trimmed.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}

Table

/V5/API/Table/AlterTable/{{tableName}}

Alter the schema of an existing table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PATCH \
  --url https://vault.melissadata.net/V5/API/Table/AlterTable/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "Columns": [
    {
      "ColumnName": "First",
      "NewColumnName": "FirstName",
      "ColumnType": "None",
      "PrimaryKey": false
    },
    {
      "ColumnName": "Last",
      "NewColumnName": "LastName",
      "ColumnType": "None",
      "PrimaryKey": false
    }
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Body Parameters
Alerts	Array object[]. Table alerts(s) to add, replace, update or delete. AlertName String | Nullable. Alert to be added, replaced, updated or deleted. Alert names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. AlertType String | Nullable. Alert type. Channel Object. Body String | Nullable. POST body (used by WebHook channel) Channel String | Nullable. Notification channel. See NotificationRecord Structure for Channel Types. Email String | Nullable. Comma-delimited list of address(es) to notify (used by Email channel) Headers Array string[]. Headers to be included in communication (used by WebHook channel). Headers should be specified in the form key=value. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule Method String | Nullable. Communication method to use (GET, POST, etc) (used by WebHook channel) Schedule String | Nullable. Notification schedule (cron expression). See NotificationRecord Structure for Schedule Types. Url String | Nullable. Url to receive notification (used by WebHook channel). The record ID of the altered record can be inserted into the Url with the macro %@record%. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule InputColumnMappings Array object[]. List of input column mappings. ColumnName String | Nullable. Table column to be mapped to ColumnType ColumnType String | Nullable. Column type. See Enumerations for Column Types. NewAlertName String | Nullable. (AlterTable only) Name of alert to add, or new alert name (rename). Alert names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. Schedule String | Nullable. Alert schedule (cron expression or ‘Default’). See Alerts for more information Status String | Nullable. Alert status. See Result & HTTP Status Codes.
Columns	Array object[]. Column(s) to add, replace, update or delete. ColumnName String | Nullable. Column to be added, replaced, updated or deleted. Column names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. ColumnType String | Nullable. Column type. See Enumerations for Column Types. NewColumnName String | Nullable. (AlterTable only) Name of column to be added, or new column name (rename). Column names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. PrimaryKey Boolean. True if the column is a primary key. A table can only have one primary key, and a table cannot have more than one record containing the same primary key value. Size Integer | Nullable - int32. Column size (text columns only). Text column sizes are limited to 4000.
Notifications	Array object[]. Table notification(s) to add, replace, update or delete. Channel Object. Body String | Nullable. POST body (used by WebHook channel) Channel String | Nullable. Notification channel. See NotificationRecord Structure for Channel Types. Email String | Nullable. Comma-delimited list of address(es) to notify (used by Email channel) Headers Array string[]. Headers to be included in communication (used by WebHook channel). Headers should be specified in the form key=value. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule Method String | Nullable. Communication method to use (GET, POST, etc) (used by WebHook channel) Schedule String | Nullable. Notification schedule (cron expression). See NotificationRecord Structure for Schedule Types. Url String | Nullable. Url to receive notification (used by WebHook channel). The record ID of the altered record can be inserted into the Url with the macro %@record%. NewNotificationName String | Nullable. (AlterTable only) Name of notification to be added or new notification name (rename). Notification names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. NotificationName String | Nullable. Notification to be added, replaced, updated or deleted. Notification names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. NotificationType String | Nullable. Type of notification. Rules Array object[]. List of notification rules Column String | Nullable. Name of column to monitor (used by ResultCodeAdded and ResultCodeDropped rule types) Columns String | Nullable. Comma-delimited list of columns to monitor (used by ColumnsAdded and ColumnsDropped rule types Expression String | Nullable. Boolean expression to evaluate and monitor (used by ExpressionAdded and ExpressionDropped rule types ResultCodes String | Nullable. Comma-delimited list of result codes to monitor (used by ResultCodeAdded and ResultCodeDropped rule types Rule String | Nullable. Notification rule. See NotificationRecord Structure for Rule Types.
Tags	Array object[]. Tags associated with the table. Color String | Nullable. Tag color. Name String | Nullable. Tag name.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

AlterTable can be used to add, replace, update or delete a table’s columns. ColumnName and NewColumnName dictate the action to be taken:

ColumnName	NewColumnName	Type/Size/PrimaryKey	Action
Specified	Same as ColumnName	Same as current schema	No changes made to column
Specified	Same as ColumnName	Not same as current schema	Column’s schema altered
Specified	Not same as ColumnName	Same as current schema	Column renamed
Specified	Not same as ColumnName	Not same as current schema	Rename column and alter column’s schema
[Empty] or NULL	Specified	Specified	Add column with the specified schema
Specified	[Empty] or NULL	(N/A)	Delete column

The same logic is used for Alerts (AlertName) and Notifications (NotificationName). Tags are always replaced in entirety.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

/V5/API/Table/CreateTable/{{tableName}}

Create a new table​.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request POST \
  --url https://vault.melissadata.net/V5/API/Table/CreateTable/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "Columns": [
    {
      "ColumnName": "FirstName",
      "ColumnType": "FirstName",
      "Size": 20,
      "PrimaryKey": false
    },
    {
      "ColumnName": "LastName",
      "ColumnType": "LastName",
      "Size": 20,
      "PrimaryKey": false
    },
    {
      "ColumnName": "Address",
      "ColumnType": "Address",
      "Size": 40,
      "PrimaryKey": false
    },
    {
      "ColumnName": "City",
      "ColumnType": "City",
      "Size": 30,
      "PrimaryKey": false
    },
    {
      "ColumnName": "State",
      "ColumnType": "State",
      "Size": 2,
      "PrimaryKey": false
    },
    {
      "ColumnName": "PostalCode",
      "ColumnType": "PostalCode",
      "Size": 10,
      "PrimaryKey": false
    }
  ],
  "Tags": [
    {
      "Name": "Suppression",
      "Color": "#FF0000"
    },
    {
      "Name": "Pensky Project",
      "Color": "#00FF00"
    }
  ]
}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options HiddenTable
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Body Parameters
Alerts	Array object[]. Table alerts(s) to add, replace, update or delete. AlertName String | Nullable. Alert to be added, replaced, updated or deleted. Alert names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. AlertType String | Nullable. Alert type. Channel Object. Body String | Nullable. POST body (used by WebHook channel) Channel String | Nullable. Notification channel. See NotificationRecord Structure for Channel Types. Email String | Nullable. Comma-delimited list of address(es) to notify (used by Email channel) Headers Array string[]. Headers to be included in communication (used by WebHook channel). Headers should be specified in the form key=value. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule Method String | Nullable. Communication method to use (GET, POST, etc) (used by WebHook channel) Schedule String | Nullable. Notification schedule (cron expression). See NotificationRecord Structure for Schedule Types. Url String | Nullable. Url to receive notification (used by WebHook channel). The record ID of the altered record can be inserted into the Url with the macro %@record%. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule InputColumnMappings Array object[]. List of input column mappings. ColumnName String | Nullable. Table column to be mapped to ColumnType ColumnType String | Nullable. Column type. See Enumerations for Column Types. NewAlertName String | Nullable. (AlterTable only) Name of alert to add, or new alert name (rename). Alert names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. Schedule String | Nullable. Alert schedule (cron expression or ‘Default’). See Alerts for more information Status String | Nullable. Alert status. See Result & HTTP Status Codes.
Columns	Array object[]. Column(s) to add, replace, update or delete. ColumnName String | Nullable. Column to be added, replaced, updated or deleted. Column names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. ColumnType String | Nullable. Column type. See Enumerations for Column Types. NewColumnName String | Nullable. (AlterTable only) Name of column to be added, or new column name (rename). Column names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. PrimaryKey Boolean. True if the column is a primary key. A table can only have one primary key, and a table cannot have more than one record containing the same primary key value. Size Integer | Nullable - int32. Column size (text columns only). Text column sizes are limited to 4000.
Notifications	Array object[]. Table notification(s) to add, replace, update or delete. Channel Object. Body String | Nullable. POST body (used by WebHook channel) Channel String | Nullable. Notification channel. See NotificationRecord Structure for Channel Types. Email String | Nullable. Comma-delimited list of address(es) to notify (used by Email channel) Headers Array string[]. Headers to be included in communication (used by WebHook channel). Headers should be specified in the form key=value. HRSchedule String | Nullable. (Output) Human-readable interpretation of Schedule Method String | Nullable. Communication method to use (GET, POST, etc) (used by WebHook channel) Schedule String | Nullable. Notification schedule (cron expression). See NotificationRecord Structure for Schedule Types. Url String | Nullable. Url to receive notification (used by WebHook channel). The record ID of the altered record can be inserted into the Url with the macro %@record%. NewNotificationName String | Nullable. (AlterTable only) Name of notification to be added or new notification name (rename). Notification names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. NotificationName String | Nullable. Notification to be added, replaced, updated or deleted. Notification names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”. NotificationType String | Nullable. Type of notification. Rules Array object[]. List of notification rules Column String | Nullable. Name of column to monitor (used by ResultCodeAdded and ResultCodeDropped rule types) Columns String | Nullable. Comma-delimited list of columns to monitor (used by ColumnsAdded and ColumnsDropped rule types Expression String | Nullable. Boolean expression to evaluate and monitor (used by ExpressionAdded and ExpressionDropped rule types ResultCodes String | Nullable. Comma-delimited list of result codes to monitor (used by ResultCodeAdded and ResultCodeDropped rule types Rule String | Nullable. Notification rule. See NotificationRecord Structure for Rule Types.
Tags	Array object[]. Tags associated with the table. Color String | Nullable. Tag color. Name String | Nullable. Tag name.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

• Omit the Columns property entirely (set to NULL) to create a no-schema table.

• Table names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”

• Column names must satisfy the regular expression “^[p{L}d_][p{L}ds_]{0,79}$”

• See Enumerations for Column Types

• Text columns are limited to 4000 characters.

Options

HiddenTable

Boolean. Sets if a table is hidden and won’t be listed by GetTableInfo.

Parameter	Description
False	Default. Table is NOT hidden and will be listed by GetTableInfo.
True	Table IS hidden and will not be listed by GetTableInfo.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

/V5/API/Table/DeleteTable/{{tableName}}

Delete an existing table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/Table/DeleteTable/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

/V5/API/Table/GetTableInfo/{{tableName}}

Retrieve information about an existing table(s).

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Table/GetTableInfo/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options AllTags AnyTags HiddenTable RegularExpression
ORDER	String. T-SQL representation of ORDER BY clause.
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
TAGS	String. A comma-separated (,) list of tags to filter by. By default all tags are selected.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

If PGSIZE and/or PGNO are not specified, the default page size is 1000 and the default page number is 0.

Options

AllTags

Boolean. Sets if ALL of the specified tags are required in a table’s tags.

Parameter	Description
False	Default. All specified tags are NOT required in the table’s tags.
True	All specified tags ARE required in the table’s tags.

AnyTags

Boolean. Sets if ANY of the specified tags are required in a table’s tags.

Parameter	Description
False	Any of the specified tags are NOT required in the table’s tags.
True	Default. Any of the specified tags ARE required in the table’s tags.

HiddenTable

Boolean. Sets if a table is hidden and won’t be listed by GetTableInfo.

Parameter	Description
False	Default. Table is NOT hidden and will be listed by GetTableInfo.
True	Table IS hidden and will not be listed by GetTableInfo.

RegularExpression

Boolean. Sets if TABLE is matched as a regular expression.

Parameter	Description
False	Default. TABLE is NOT matched as a regular expression.
True	TABLE IS matched as a regular expression.

Response

{
  "TransmissionResults": "",
  "Tables": [
    {
      "TableName": "HomesData",
      "NoSchema": false,
      "Locked": false,
      "Hidden": false,
      "Count": 12356,
      "Created": "0001-01-01T00:00:00",
      "Updated": "0001-01-01T00:00:00",
      "Columns": [
        {
          "ColumnName": "FirstName",
          "ColumnType": "FirstName",
          "Size": 20,
          "PrimaryKey": false
        },
        {
          "ColumnName": "LastName",
          "ColumnType": "LastName",
          "Size": 20,
          "PrimaryKey": false
        },
        {
          "ColumnName": "Address",
          "ColumnType": "Address",
          "Size": 40,
          "PrimaryKey": false
        },
        {
          "ColumnName": "City",
          "ColumnType": "City",
          "Size": 30,
          "PrimaryKey": false
        },
        {
          "ColumnName": "State",
          "ColumnType": "State",
          "Size": 2,
          "PrimaryKey": false
        },
        {
          "ColumnName": "PostalCode",
          "ColumnType": "PostalCode",
          "Size": 10,
          "PrimaryKey": false
        }
      ],
      "Tags": [
        {
          "Name": "Suppression",
          "Color": "#FF0000"
        },
        {
          "Name": "Pensky Project",
          "Color": "#00FF00"
        }
      ],
      "RunningProcesses": [
        "af8ee22b-586d-4fb7-9aa0-73df579d1118"
      ]
    }
  ],
  "TotalTables": 0,
  "TransmissionReference": "TEST"
}

/V5/API/Table/GetTableTags/{{tableName}}

Retrieve list of table tags​.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Table/GetTableTags/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
OPT	Set Options HiddenTable RegularExpression
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

HiddenTable

Boolean. Sets if a table is hidden and won’t be listed by GetTableInfo.

Parameter	Description
False	Default. Table is NOT hidden and will be listed by GetTableInfo.
True	Table IS hidden and will not be listed by GetTableInfo.

RegularExpression

Boolean. Sets if TABLE is matched as a regular expression.

Parameter	Description
False	Default. TABLE is NOT matched as a regular expression.
True	TABLE IS matched as a regular expression.

Response

{
  "TransmissionResults": "",
  "Tags": [
    {
      "Name": "Pensky Project",
      "Color": "#00FF00"
    },
    {
      "Name": "Suppression",
      "Color": "#FF0000"
    }
  ],
  "TransmissionReference": "TEST"
}

/V5/API/Table/RenameTable/{{tableName}}

Rename an existing table.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request PUT \
  --url https://vault.melissadata.net/V5/API/Table/RenameTable/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
NEWTABLE	String. New table name.
OPT	Set Options HiddenTable
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Options

HiddenTable

Boolean. Sets if a table is hidden and won’t be listed by GetTableInfo.

Parameter	Description
False	Default. Table is NOT hidden and will be listed by GetTableInfo.
True	Table IS hidden and will not be listed by GetTableInfo.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

/V5/API/Table/TestNotification/{{tableName}}

Test a new or existing table notification.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Table/TestNotification/HomesData \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "CustomerID": "{{customerId}}",
  "TableName": "HomesData",
  "NotificationName": "SmartMover Notifications",
  "Channel": {
    "Channel": "WebHook",
    "Url": "http://www.example.com",
    "Method": "POST",
    "Headers": [
      "Content-Type=application/json"
    ],
    "Body": "{ \"recordId\": \"%@record%\", \"Name\": \"^Name^\", \"Address\": \"^Address^\", \"City\": \"^City^\", \"State\": \"^State^\", \"PostalCode\": \"^PostalCode^\", \"resultCode\": \"^resultCode^\" }"
  },
  "TransmissionReference": "TEST"
}'

Request Parameters

Code	Description
Record Level Parameters
NOTIFICATION	String. Notification name.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Body Parameters
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

If NotificationName is populated, then the existing table notification specified is tested. If Channel is populated, then the new notification specified in Channel is tested. If both are specified, then only NotificationName is used. See Notifications for more information.

Response

{
  "TransmissionResults": "",
  "StatusCode": "200",
  "RequestUrl": "http://www.example.com",
  "RequestMethod": "POST",
  "RequestHeaders": [
    "Content-Type=application/json"
  ],
  "ResponseHeaders": [
    "Content-Type=application/json"
  ],
  "RequestBody": "{ \"recordId\": \"99999\", \"Name\": \"SAMPLE_DATA\", \"Address\": \"SAMPLE_DATA\", \"City\": \"SAMPLE_DATA\", \"State\": \"SAMPLE_DATA\", \"PostalCode\": \"SAMPLE_DATA\", \"resultCode\": \"SAMPLE_DATA\" }",
  "ResponseBody": "{\"_index\":\"webhook-2022.07\",\"_type\":\"smartmover\",\"_id\":\"Kx8v2oEBWg7PFy9Paww6\",\"_version\":1,\"result\":\"created\",\"_shards\":{\"total\":2,\"successful\":2,\"failed\":0},\"_seq_no\":2871,\"_primary_term\":1}",
  "ElapsedTime": "0.221"
}

/V5/API/Table/TruncateTable/{{tableName}}

Delete all records from an existing table​.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request DELETE \
  --url https://vault.melissadata.net/V5/API/Table/TruncateTable/HomesData \
  --header 'Authorization: {{customerId}}'

Request Parameters

Code	Description
Record Level Parameters
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Path Parameters
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Response

{
  "TransmissionResults": "",
  "TransmissionReference": "TEST"
}

Transaction

/V5/API/Transaction/TransactionRecords/{{tableName}}/{{primaryKey}}

Retrieve a table’s record transactions.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url 'https://vault.melissadata.net/V5/API/Transaction/TransactionRecords/HomesData/8008006245,5089617240' \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
OPT	Set Options CountAllRecords IncludeNulls JoinCondition KeysAre@Records TransactionOrder
ORDER	String. T-SQL representation of ORDER BY clause.
PGNO	Integer (32bit). Page number of records to return (0 is the first page).
PGSIZE	Integer (32bit). Number of records to output per paged request.
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
TYPE	String. A comma-separated (,) list of Transaction types to retrieve.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CountAllRecords

Boolean. Sets if TotalSelectRecords will contain a count of all records that satisfy the specified query, otherwise it is set to 0.

Parameter	Description
False	Default. TotalSelectRecords is set to 0.
True	TotalSelectRecords will contain a count of all records for the query.

IncludeNulls

Boolean. Sets if the response includes columns that are set to null.

Parameter	Description
True	Default. Includes columns set to null.
False	Does not include columns set to null.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

Response

{
  "TransmissionResults": "",
  "Records": [
    [
      {
        "@record": 1,
        "FirstName": "John",
        "LastName": "Smith",
        "Address": "10 Smith St",
        "City": "Springfield",
        "State": "CA",
        "PostalCode": "99876-1024",
        "@transactionDate": "2022-10-21T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "Address,City,PostalCode"
      },
      {
        "@record": 1,
        "FirstName": "John",
        "LastName": "Smith",
        "Address": "123 Main St Apt 1",
        "City": "Anytown",
        "State": "CA",
        "PostalCode": "12345",
        "@transactionDate": "2021-03-15T00:00:00",
        "@transactionType": "Insert",
        "@transactionSubUser": 1,
        "@transactionColumns": "FirstName,LastName,Address,City,State,PostalCode"
      }
    ],
    [
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Smith-Doe",
        "Address": "10 Smith St",
        "City": "Springfield",
        "State": "CA",
        "PostalCode": "99876-1024",
        "@transactionDate": "2022-10-21T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "LastName,Address,City,PostalCode"
      },
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Doe",
        "Address": "123 Main St Apt 1",
        "City": "Anytown",
        "State": "CA",
        "PostalCode": "12345",
        "@transactionDate": "2018-03-18T00:00:00",
        "@transactionType": "SmartMover",
        "@transactionSubUser": 1,
        "@transactionColumns": "Address,City,State,PostalCode"
      },
      {
        "@record": 2,
        "FirstName": "Jane",
        "LastName": "Doe",
        "Address": "15 University Ave",
        "City": "Dartmouth",
        "State": "NH",
        "PostalCode": "10028",
        "@transactionDate": "2015-02-22T00:00:00",
        "@transactionType": "Insert",
        "@transactionSubUser": 1,
        "@transactionColumns": "FirstName,LastName,Address,City,State,PostalCode"
      }
    ]
  ],
  "TotalTransactionRecords": 0,
  "TransmissionReference": "TEST"
}

Transaction (FTP)

/V5/API/Transaction/TransactionRecordsFTP/{{tableName}}/{{primaryKey}}

Retrieve a table’s record transactions for download.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url https://vault.melissadata.net/V5/API/Transaction/TransactionRecordsFTP/HomesData/8008006245 \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema JoinCondition KeysAre@Records OverwriteOutputFile TransactionOrder TransactionStyle
ORDER	String. T-SQL representation of ORDER BY clause.
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
TYPE	String. A comma-separated (,) list of Transaction types to retrieve.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited file format.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

TransactionStyle

String. Sets the transaction layout.

Parameter	Description
Flat	Default. Transactions are output as a simple list.
Hierarchical	Transactions are output in a tiered manner. Delimited files add a column with a * to indicate the first transaction in a set. Excel files group transactions and color changed data.
Delta	A single record is output for each changed record, containing its current value.

Response

{
  "TransmissionResults": "",
  "FileName": "50140c99-c874-427b-80db-492f360fe663",
  "Url": "ftp://vault.melissadata.net/50140c99-c874-427b-80db-492f360fe663",
  "Checksum": "26D6725C49831643E8EC87B1644D167205EC4F9F0FEAC57BE058A1EF5FBC9E46",
  "TransmissionReference": "TEST"
}

Transaction (FTP Async)

/V5/API/Transaction/TransactionRecordsFTPAsync/{{tableName}}/{{primaryKey}}

Retrieve a table’s record transactions for download asynchronously.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

curl --request GET \
  --url 'https://vault.melissadata.net/V5/API/Transaction/TransactionRecordsFTPAsync/HomesData/8008006245,5089617240' \
  --header 'Authorization: {{customerId}}' \
  --header 'Content-Type: application/json' \
  --data '{}'

Request Parameters

Code	Description
Record Level Parameters
COLS	String. Comma-separated list of columns to output (see SelectionColumns)
FILE	String. The name for the output file.
FORMAT	String. The format of output file (Delimited, Json or Excel).
OPT	Set Options CompressFile Delimiter Encoding FirstRowSchema JoinCondition KeysAre@Records OverwriteOutputFile TransactionOrder TransactionStyle
ORDER	String. T-SQL representation of ORDER BY clause.
START	String. Earliest transaction date in the following format: YYYY-MM-DDTHH:MM:SS.
T	Optional. String. This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
TYPE	String. A comma-separated (,) list of Transaction types to retrieve.
WHERE	String. T-SQL representation of WHERE condition.
Path Parameters
{{primaryKey}}	String. A comma-separated list of PrimaryKeys of record(s) to retrieve.
{{tableName}}	String. Table name. [blank] will list all tables. A regular expression may be used to query multiple tables.

Notes

PrimaryKeys

If multiple Primary Keys are to be selected, list them in the body’s PrimaryKeyValues property. If the table does not have a primary key, the records’ @record value should be used. The KeysAre@Records option can be used to use @record when the table does contain a primary key but selection by @record id desired.

WhereCondition

The WHERE parameter can contain a T-SQL compatible WHERE expression that will filter selected records. Columns used in WHERE do not need to appear in COLS. If used simultaneously with the KEYS parameter, the JoinCondition option can be used to specify whether both (And) or either (Or) properties must be satisfied in order for a record to be returned.

Options

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter

CompressFile

Boolean. Sets if the download file will be compressed using zip compression.

Parameter	Description
False	Default. The download file will not be compressed.
True	The download file will be compressed.

Delimiter

String. Sets the delimiter used in the delimited file format.

Parameter	Description
Colon	Delimiter is a colon: :.
Comma	Default. Delimiter is a comma: ,.
Pipe	Delimiter is a pipe: |.
Semicolon	Delimiter is a semicolon: ;.
Tab	Delimiter is a tab.

Encoding

String. Sets the output file’s encoding for the delimited file format.

Parameter	Description
ASCII	File encoding set to ASCII.
UTF-8	Default. File encoding set to UTF-8.
windows-1252	File encoding set to windows-1252.

FirstRowSchema

Boolean. For Delimited and Excel file formats, sets if the first record will contain the table’s schema.

Parameter	Description
False	Default. The first record will not contain the table schema.
True	The first record will contain the table schema.

JoinCondition

String. If both KEYS and WHERE are specified, this sets whether either condition needs to be satisfied (or) or both (and).

Parameter	Description
and	Default. Both conditions need to be satisfied.
or	Either condition needs to be satisfied.

KeysAre@Records

Boolean. Sets if records having the same @record as the specified PrimaryKey(s) will be selected.

Parameter	Description
False	Default. Matching records will not be selected.
True	Matching records will be selected.

OverwriteOutputFile

Boolean. Sets if the output file will be overwritten if it already exists.

Parameter	Description
False	Default. The output file will NOT be overwritten.
True	The output file WILL be overwritten.

TransactionOrder

String. Sorts the record transaction orders.

Parameter	Description
EarliestToLatest	Default. Transactions are ordered from earliest to latest.
LatestToEarliest	Transactions are ordered from latest to earliest.
LatestThenEarliest	Transactions are ordered with the latest first, followed by the remainders ordered earliest to latest.

TransactionStyle

String. Sets the transaction layout.

Parameter	Description
Flat	Default. Transactions are output as a simple list.
Hierarchical	Transactions are output in a tiered manner. Delimited files add a column with a * to indicate the first transaction in a set. Excel files group transactions and color changed data.
Delta	A single record is output for each changed record, containing its current value.

Response

{
  "TransmissionResults": "",
  "ProcessID": "8716632a-a32a-4c09-a3f6-589b8af6eeae",
  "TransmissionReference": "TEST"
}