Service API

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Export started ServiceExportStatusDTO

400

Error downloading list ServiceApiErrorDTO

get /api/service/lists/{listId}/async

Exports a list specified by the listId asynchronously (asynchronous Download ListUsingGET)

Path parameters

listId (required)

Path Parameter — the id of the List to download format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

format (required)

Query Parameter — format of the list download - allowed values are 'hash' or 'plain'

hosted (optional)

Query Parameter — only return unsubscribes collected by UnsubCentral hosted unsubscribe pages - allowed values are 'true' or 'false' default: false

startDate (optional)

Query Parameter — include records added after the specified date - format is yyyy-MM-dd format: date-time

endDate (optional)

Query Parameter — include records before the specified date - format is yyyy-MM-dd format: date-time

deactivate (optional)

Query Parameter — true - export deactivated emails, false - export active emails. default = false

addlCols (optional)

Query Parameter — true - export additional columns, false - export email only. default = false

all (optional)

Query Parameter — true - export all emails, false - export active or deactivated emails. default = false

Return type

CheckAddressBatchResultDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Export started ServiceExportStatusDTO

400

Error downloading list ServiceApiErrorDTO

post /api/service/addresses/batch

Checks if the email addresses are found on a List associated with the Key (batch Check Email AddressUsingPOST)

For the JSON format for the query parameter, only specify md5, sha, sha512, or text. Combinations are not allowed. Also there is a limit of 200 addresses at a time. The return object will have all of the emails sent in the query with the property 'contains' set to either true or false.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

query CheckAddressBatchQueryDTO (required)

Body Parameter — email addresses to check, either text or hash, sent as a JSON object. See CheckAddressBatchQueryDTO. JSON Format: { "md5": [ "string","array" ], "sha": [ "string","array" ], "sha512": [ "string","array" ], "text": [ "string","array" ]}

Query parameters

keyString (required)

Query Parameter — the key to check

s (required)

Query Parameter — the s parameter for the key

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Check email response result CheckAddressBatchResultDTO

400

Error checking email ServiceApiErrorDTO

post /api/service/phone/batch

Checks if the phone addresses are found on a List associated with the Key (batch Check Phone AddressUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

query CheckAddressBatchQueryDTO (required)

Body Parameter — phone addresses to check, either text or hash, sent as a JSON object. See CheckAddressBatchQueryDTO. JSON Format: { "md5": [ "string","array" ], "sha": [ "string","array" ], "sha512": [ "string","array" ], "text": [ "string","array" ]}

Query parameters

keyString (required)

Query Parameter — the key to check

s (required)

Query Parameter — the s parameter for the key

Return type

CheckAddressBatchResultDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Check phone response result CheckAddressBatchResultDTO

400

Error checking phone ServiceApiErrorDTO

post /api/service/addresses/check

Checks if email address is found on a List associated with the Key (check Email AddressUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

keyString (required)

Query Parameter — the key to check

s (required)

Query Parameter — the s parameter for the key

email (required)

Query Parameter — email address to check - either text or hash

Return type

CheckAddressResultDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Check email response CheckAddressResultDTO

400

Error checking email ServiceApiErrorDTO

post /api/service/phone/check

Checks if phone number is found on a List associated with the Key (check Phone NumberUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

keyString (required)

Query Parameter — the key to check

s (required)

Query Parameter — the s parameter for the key

phone (required)

Query Parameter — phone number to check - either text or hash

Return type

CheckAddressResultDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Check phone number response CheckAddressResultDTO

400

Error checking phone number ServiceApiErrorDTO

post /api/service/keys

Creates a new Key for a List (create Affiliate KeyUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

listId (required)

Query Parameter — the list associated with the key format: int64

affiliateName (required)

Query Parameter — the name of the affiliate

allowPlain (optional)

Query Parameter — allow plain text download - allowed values are 'true' or 'false' default: false

allowHash (optional)

Query Parameter — allow hash download - allowed values are 'true' or 'false' default: false

allowDelta (optional)

Query Parameter — allow delta download - allowed values are 'true' or 'false' default: false

allowScrub (optional)

Query Parameter — allow scrubbing - allowed values are 'true' or 'false' default: false

redirect (optional)

Query Parameter — redirect to the affiliate key page - allowed values are 'true' or 'false' default: false

expiryDate (optional)

Query Parameter — key expiration date - format is yyyy-MM-dd

unsubPageId (optional)

Query Parameter — Unsubpage Id

allowUpload (optional)

Query Parameter — allow upload - allowed values are 'true' or 'false' default: false

hideUsage (optional)

Query Parameter — Hide key usage - allowed values are 'true' or 'false' default: false

allowAuthentication (optional)

Query Parameter — allow authentication - allowed values are 'true' or 'false' default: false

customMessage (optional)

Query Parameter — customMessage

companyName (optional)

Query Parameter — companyName

Return type

ServiceKeyDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceKeyDTO

201

Affiliate Key Created ServiceKeyDTO

307

Affiliate Key Created and redirected to Affiliate page

400

Error creating Affiliate Key ServiceApiErrorDTO

post /api/service/lists

Creates a new list. (create New ListUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

listName (required)

Query Parameter — the name of the list to create

unsubPageId (optional)

Query Parameter — Unsubpage Id

Return type

ServiceUnsubListDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceUnsubListDTO

201

List Created ServiceUnsubListDTO

400

Error creating list ServiceApiErrorDTO

delete /api/service/lists/{listId}

Deletes a list (delete ListUsingDELETE)

Path parameters

listId (required)

Path Parameter — the id of the List to be deleted format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

List deleted

400

Error deleting list ServiceApiErrorDTO

get /api/service/keys/{keyString}

Exports a list specified by the keyString (download List with the KeyUsingGET)

Path parameters

keyString (required)

Path Parameter — the key string of the key to download

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

s (required)

Query Parameter — the s parameter for the key to download

format (required)

Query Parameter — format of the list download - allowed values are 'hash' or 'plain'

zipped (optional)

Query Parameter — whether or not the file should be zipped - allowed values are 'true' or 'false' default: true

hosted (optional)

Query Parameter — only return unsubscribes collected by UnsubCentral hosted unsubscribe pages - allowed values are 'true' or 'false' default: false

startDate (optional)

Query Parameter — include records added after the specified date - format is yyyy-MM-dd format: date-time

endDate (optional)

Query Parameter — include records before the specified date - format is yyyy-MM-dd format: date-time

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

the List File

400

Error downloading list ServiceApiErrorDTO

get /api/service/lists/{listId}

Exports a list specified by the listId (download ListUsingGET)

Path parameters

listId (required)

Path Parameter — the id of the List to download format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

format (required)

Query Parameter — format of the list download - allowed values are 'hash' or 'plain'

zipped (optional)

Query Parameter — whether or not the file should be zipped - allowed values are 'true' or 'false' default: true

hosted (optional)

Query Parameter — only return unsubscribes collected by UnsubCentral hosted unsubscribe pages - allowed values are 'true' or 'false' default: false

startDate (optional)

Query Parameter — include records added after the specified date - format is yyyy-MM-dd format: date-time

endDate (optional)

Query Parameter — include records before the specified date - format is yyyy-MM-dd format: date-time

deactivate (optional)

Query Parameter — true - export deactivated emails, false - export active emails. default = false

addlCols (optional)

Query Parameter — true - export additional columns, false - export email only. default = false

all (optional)

Query Parameter — true - export all emails, false - export active or deactivated emails. default = false

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

the List File

400

Error downloading list ServiceApiErrorDTO

get /api/service/lists/{listId}/async/{exportTaskId}/status

Check the status of an Export (export StatusUsingGET)

Path parameters

listId (required)

Path Parameter — the list id of the list to download format: int64

exportTaskId (required)

Path Parameter — the Export Task Id. this value is obtained after starting an Export format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Export Status ServiceExportStatusDTO

400

Error checking status ServiceApiErrorDTO

get /api/service/keys/{keyString}/async/{exportTaskId}/status

Check the status of an Export (export StatusUsingGET1)

Path parameters

keyString (required)

Path Parameter — the key string of the key to download

exportTaskId (required)

Path Parameter — the Export Task Id. this value is obtained after starting an Export format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Export Status ServiceExportStatusDTO

400

Error checking status ServiceApiErrorDTO

get /api/service/check/ping

Health Check - Ping (health Check PingUsingGET)

Consumes

This API call consumes the following media types via the request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

post /api/service/lists/{listId}/email

Imports an email address to an existing list (import Email AddressUsingPOST)

Path parameters

listId (required)

Path Parameter — the id of the List to import into format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

email (required)

Query Parameter — the email to import into the list

type (required)

Query Parameter — type of email. allowed values - text, md5, sha, sha512

deactivate (optional)

Query Parameter — true - deactivate the email, false - deactivate the email. default = false

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

get /api/service/lists/{listId}/email/{importTaskId}/status

Check the status of an Email Import (import Email StatusUsingGET)

Path parameters

listId (required)

Path Parameter — the id of the List that is being imported into format: int64

importTaskId (required)

Path Parameter — the Import Task Id. this value is obtained after starting an import format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Import status ServiceImportStatusDTO

400

Error checking status ServiceApiErrorDTO

post /api/service/lists/{listId}/phone

Imports a phone number to an existing list (import Phone NumberUsingPOST)

Path parameters

listId (required)

Path Parameter — the id of the List to import into format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

phone (required)

Query Parameter — the phone number to import into the list

type (required)

Query Parameter — type of phone number. allowed values - text, md5, sha, sha512

deactivate (optional)

Query Parameter — true - deactivate the phone number, false - deactivate the phone number. default = false

Return type

ServiceStandaloneScrubStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceImportStatusDTO

201

Import started ServiceImportStatusDTO

400

Error importing ServiceApiErrorDTO

get /api/service/lists

Get lists (listsUsingGET)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

lastUploadDate (optional)

Query Parameter — Show the date the list was last uploaded into - allowed values are 'true' or 'false'

Return type

ServiceListsDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Lists Returned ServiceListsDTO

400

Error retrieving lists ServiceApiErrorDTO

get /api/service/keys/{keyString}/scrub/{scrubId}/status

Check the status of a Scrub (scrub StatusUsingGET)

Path parameters

keyString (required)

Path Parameter — the key used to perform the scrub

scrubId (required)

Path Parameter — the Scrub Id. this value is obtained after starting a scrub format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

s (required)

Query Parameter — the s parameter for the key

Return type

ServiceScrubStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Scrub status ServiceScrubStatusDTO

400

Error checking status ServiceApiErrorDTO

post /api/service/keys/{keyString}/scrub

Scrubs an uploaded file using a Key (scrub a ListUsingPOST)

Path parameters

keyString (required)

Path Parameter — the key to use to perform the scrub

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Query parameters

s (required)

Query Parameter — the s parameter for the key

format (required)

Query Parameter — the format of the result file - either matching or nonmatching

Form parameters

file (required)

Form Parameter — the file to import into the list

Return type

ServiceScrubStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceScrubStatusDTO

201

Scrub started ServiceScrubStatusDTO

400

Error scrubbing ServiceApiErrorDTO

post /api/service/scrub

Saves StandaloneScrubs (save StandaloneScrubUsingPOST)

Consumes

This API call consumes the following media types via the request header:

application/json

Query parameters

refSource (required)

Query Parameter — the referenceSourceType - either list/key/file

refFormat (required)

Query Parameter — the referenceFormat - either text/md5/sha/sha512

refColumnNumber (optional)

Query Parameter — the reference email column Number format: int32

refDelimiter (optional)

Query Parameter — the reference file delimiter

refListId (optional)

Query Parameter — the reference listID format: int64

refKeyString (optional)

Query Parameter — the reference keyString

canSource (required)

Query Parameter — the candidateSourceType - either list/key/file

canFormat (required)

Query Parameter — the candidateFormat - either text/md5/sha/sha512

canColumnNumber (optional)

Query Parameter — the candidate email column Number format: int32

canDelimiter (optional)

Query Parameter — the candidate file delimiter

canListId (optional)

Query Parameter — the candidate listID format: int64

canKeyString (optional)

Query Parameter — the candidate keyString

format (required)

Query Parameter — the format of the result file - either matching or nonmatching

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceStandaloneScrubStatusDTO

201

StandaloneScrub saved ServiceStandaloneScrubStatusDTO

400

Error saving standaloneScrub ServiceApiErrorDTO

get /api/service/scrub/{scrubId}/status

Check the status of a StandaloneScrub (standaloneScrub StatusUsingGET)

Path parameters

scrubId (required)

Path Parameter — the StandaloneScrub Id. this value is obtained after starting a standaloneScrub format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

ServiceStandaloneScrubStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

StandaloneScrub status ServiceStandaloneScrubStatusDTO

400

Error checking standaloneScrub status ServiceApiErrorDTO

put /api/service/scrub/{scrubId}/start

the standaloneScrub ID (start StandaloneScrubUsingPUT)

Path parameters

scrubId (required)

Path Parameter — the StandaloneScrub id format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

ServiceStandaloneScrubStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

start StandaloneScrub ServiceStandaloneScrubStatusDTO

400

Error while scrubbing ServiceApiErrorDTO

post /api/service/scrub/{scrubId}/candidate

the candidate file (upload Candidate File for ScrubUsingPOST)

Path parameters

scrubId (required)

Path Parameter — the StandaloneScrub id format: int64

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Form parameters

file (required)

Form Parameter — the file to scrub

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

candidate file uploaded

400

Error uploading candidate file

post /api/service/scrub/{scrubId}/reference

the reference file (upload Reference File for ScrubUsingPOST)

Path parameters

scrubId (required)

Path Parameter — the StandaloneScrub id format: int64

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Form parameters

file (required)

Form Parameter — the file to scrub

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

reference file uploaded

400

Error uploading reference file

post /api/service/domains/upload

Upload a site domain suppression list (upload DomainsUsingPOST)

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Query parameters

regex (optional)

Query Parameter — the contents of the file are regular expressions for domains default: false

Form parameters

file (required)

Form Parameter — the domain suppression file

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

201

Domains imported successfully

400

Error importing domains ServiceApiErrorDTO

post /api/service/lists/{listId}/upload

Imports a file into an existing list (upload ListUsingPOST)

Path parameters

listId (required)

Path Parameter — the id of the List to import into format: int64

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Query parameters

deactivate (optional)

Query Parameter — true - deactivate the email, false - do not deactivate the email. default = false

Form parameters

file (required)

Form Parameter — the file to import into the list

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceImportStatusDTO

201

Import started ServiceImportStatusDTO

400

Error importing ServiceApiErrorDTO

get /api/service/lists/{listId}/upload/{importTaskId}/status

Check the status of a List Import (upload StatusUsingGET)

Path parameters

listId (required)

Path Parameter — the id of the List that is being imported into format: int64

importTaskId (required)

Path Parameter — the Import Task Id. this value is obtained after starting an import format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

ServiceKeyImportStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Import status ServiceImportStatusDTO

400

Error checking status ServiceApiErrorDTO

post /api/service/keys/{keyString}/upload

Imports a file into an existing list by using Key (upload List Using Key POST)

Path parameters

keyString (required)

Path Parameter — the key used to perform import into List

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Query parameters

deactivate (optional)

Query Parameter — true - deactivate the email, false - do not deactivate the email. default = false

Form parameters

file (required)

Form Parameter — the file to import into the list by using key

Return type

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK ServiceKeyImportStatusDTO

201

Import started ServiceKeyImportStatusDTO

400

Error importing ServiceApiErrorDTO

get /api/service/keys/{keyId}/upload/{importTaskId}/status

Check the status of a List Import by using key (upload StatusUsingGET)

Path parameters

keyId (required)

Path Parameter — the id of the Key to import into format: int64

importTaskId (required)

Path Parameter — the Import Task Id. this value is obtained after starting an import format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

ServiceKeyImportStatusDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Import status ServiceKeyImportStatusDTO

400

Error checking status ServiceApiErrorDTO

get /api/service/me

userInfo (userInfoUsingGET)

Consumes

This API call consumes the following media types via the request header:

application/json

Return type

UserDTO

Example data

Content-Type:

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

OK UserDTO

post /api/webhook/{listId}/importEmail/{type}

Import emails to an existing list (import Emails using webhook api)

Path parameters

type (required)

Path Parameter — the type of the emails - either unsubscribe/subscribe

- Note, subscribe would indicate an email is active on a list and most common

Request body

query WebhookImportPayLoad (required)

Body Parameter — email addresses to import, sent as a JSON object. See WebhookImportPayLoad. JSON Format: { "emails": [ "string","array" ] }

Consumes

This API call consumes the following media types via the request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

post /api/webhook/{listToken}/exclusion

list exclusion webhook api for list token (list exclusion webhook api for list token)

Path parameters

listToken (required)

Path Parameter — list token

Query parameters

sender (required)

Query Parameter — the sender parameter for sender email address

recipient (required)

Query Parameter — the recipient parameter for list of recipient email addresses with comma separated

Consumes

This API call consumes the following media types via the request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

*/*

Responses

200

Models

[ Jump to Methods ]

CheckAddressBatchQueryDTO -
CheckAddressBatchResultDTO -
CheckAddressResultDTO -
Exception -
File -
ServiceApiErrorDTO -
ServiceExportStatusDTO -
ServiceImportStatusDTO -
ServiceImportStatusDTO -
ServiceKeyDTO -
ServiceListsDTO -
ServiceScrubStatusDTO -
ServiceStandaloneScrubStatusDTO -
ServiceUnsubListDTO -
SiteDTO -
StackTraceElement -
Throwable -
UserDTO -
UserRoleDTO -
WebhookImportPayLoad -

`CheckAddressBatchQueryDTO` - Up

Only specify the md5, sha, sha512, or text array. Combinations are not allowed.

md5 (optional)

sha (optional)

sha512 (optional)

text (optional)

`CheckAddressBatchResultDTO` - Up

only one of the following fields, md5, sha, sha512, or text, will be set with either contains being true or false

contains (optional)

Boolean true if the search query is found

md5 (optional)

String search query

sha (optional)

String search query

sha512 (optional)

String search query

text (optional)

String search query

`CheckAddressResultDTO` - Up

addressFound (optional)

Boolean If the email address was found

`Exception` - Up

cause (optional)

Throwable

localizedMessage (optional)

message (optional)

stackTrace (optional)

array[StackTraceElement]

suppressed (optional)

array[Throwable]

errorMessage (optional)

String if the export failed, this is the reason

exportStatusUrl (optional)

String url to check the status of the export

exportTaskId (optional)

Long the export task id format: int64

finished (optional)

Boolean indicates whether the export is finished or not

progress (optional)

Double the progress of the export format: double

`ServiceImportStatusDTO` - Up

errorMessage (optional)

String if the import failed, this is the reason

finished (optional)

Boolean indicates whether the import is finished or not

importStatusUrl (optional)

String url to check the status of the import

importTaskId (optional)

Long the import task id format: int64

listId (optional)

Long the list id format: int64

migrationException (optional)

Exception

progress (optional)

Integer the progress of the import format: int32

`ServiceKeyImportStatusDTO` - Up

errorMessage (optional)

String if the import failed, this is the reason

finished (optional)

Boolean indicates whether the import is finished or not

importStatusUrl (optional)

String url to check the status of the import

importTaskId (optional)

Long the import task id format: int64

keyId (optional)

Long the key id format: int64

migrationException (optional)

Exception

progress (optional)

Integer the progress of the import format: int32

`ServiceKeyDTO` - Up

affiliateUrl (optional)

String affiliate url

keyString (optional)

String key string

s (optional)

String s parameter

`ServiceListsDTO` - Up

dateLastUpdated (optional)

Date date last uploaded into format: date-time

listId (optional)

Long list id format: int64

listName (optional)

String list name

`ServiceScrubStatusDTO` - Up

downloadUrl (optional)

String when the scrub is successfully completed, this is the url to the results file

errorMessage (optional)

String if the scrub failed, this is the reason

finished (optional)

Boolean indicates whether the scrub is finished or not

percentComplete (optional)

Integer the progress of the scrub format: int32

scrubId (optional)

Long the scrub id format: int64

scrubStatusUrl (optional)

String url to check the status of the scrub

waiting (optional)

Boolean indicates that the scrub is waiting to start

`ServiceStandaloneScrubStatusDTO` - Up

canLines (optional)

Integer no of lines in candidate file format: int32

canUploadUrl (optional)

String indicates the path of uploaded candidate file

downloadUrl (optional)

String when the scrub is successfully completed, this is the url to the results file

errorMessage (optional)

String if the scrub failed, this is the reason

finished (optional)

Boolean indicates whether the scrub is finished or not

percentComplete (optional)

Integer the progress of the scrub format: int32

refLines (optional)

Integer no of lines in the reference file format: int32

refUploadUrl (optional)

String indicates the path of uploaded reference file

resultLines (optional)

Integer no of lines in result file format: int32

scrubId (optional)

Long the scrub id format: int64

scrubStatusUrl (optional)

String url to check the status of the scrub

startUrl (optional)

String indicates the url of scrub, that has been started

waiting (optional)

Boolean indicates that the scrub is waiting to start

`ServiceUnsubListDTO` - Up

keyHash (optional)

String the syndication key hash for the newly created list

listId (optional)

Long the id of the newly created list format: int64

listName (optional)

String the name of the newly created list

s (optional)

String the s parameter for the key hash

`SiteDTO` - Up

active (optional)

Boolean

description (optional)

id (optional)

Long format: int64

name (optional)

partnerId (optional)

Long format: int64

siteGuid (optional)

`StackTraceElement` - Up

className (optional)

fileName (optional)

lineNumber (optional)

Integer format: int32

methodName (optional)

nativeMethod (optional)

Boolean

`Throwable` - Up

localizedMessage (optional)

message (optional)

stackTrace (optional)

array[StackTraceElement]

suppressed (optional)

array[Throwable]

`UserDTO` - Up

email (optional)

firstName (optional)

id (optional)

Long format: int64

lastName (optional)

locked (optional)

Boolean

lockedDate (optional)

Date format: date-time

password (optional)

roles (optional)

array[UserRoleDTO]

samlUserName (optional)

site (optional)

array[SiteDTO]

userName (optional)

`UserRoleDTO` - Up

name (optional)

userRoleId (optional)

Long format: int64

`WebhookDTO` - Up

id (optional)

Long format: int64

type (optional)

unsubListId (optional)

Long format: int64

url (optional)