Retrieve a list of email address import definitions

get

/api/bulk/2.0/emailAddresses/imports

Retrieves a list of email address import definitions.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : EmailAddressImportSearchResponse
Type: object
Title: EmailAddressImportSearchResponse
Show Source
Nested Schema : items
Type: array
Title: items
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve a list of email address import definitions:


GET /emailAddresses/imports
Content-Type: application/json 
			

Response:


{
    "items": [{
        "name": "Test Import",
        "fields": {
            "UnsubEmail": "{{EmailAddress.Field(EmailAddress)}}"
        },
        "identifierFieldName": "UnsubEmail",
        "syncActions": [{
            "destination": "{{GlobalSubscribe}}",
            "action": "setStatus",
            "status": "unsubscribed"
        }],
        "isSyncTriggeredOnImport": false,
        "dataRetentionDuration": "P7D",
        "isUpdatingMultipleMatchedRecords": false,
        "uri": "/emailAddresses/imports/2",
        "createdBy": "API.User",
        "createdAt": "2016-06-09T17:18:15.4530000Z",
        "updatedBy": "API.User",
        "updatedAt": "2016-06-09T17:18:15.4530000Z"
    }, {
        "name": "Test Import - Name Update",
        "fields": {
            "UnsubEmail": "{{EmailAddress.Field(EmailAddress)}}"
        },
        "identifierFieldName": "UnsubEmail",
        "syncActions": [{
            "destination": "{{GlobalSubscribe}}",
            "action": "setStatus",
            "status": "unsubscribed"
        }],
        "isSyncTriggeredOnImport": true,
        "dataRetentionDuration": "P7D",
        "isUpdatingMultipleMatchedRecords": false,
        "uri": "/emailAddresses/imports/3",
        "createdBy": "API.User",
        "createdAt": "2016-06-09T17:42:58.9470000Z",
        "updatedBy": "API.User",
        "updatedAt": "2016-06-09T17:45:14.2430000Z"
    }, {
        "name": "Test Import - Auto Delete",
        "fields": {
            "UnsubEmail": "{{EmailAddress.Field(EmailAddress)}}"
        },
        "identifierFieldName": "UnsubEmail",
        "syncActions": [{
            "destination": "{{GlobalSubscribe}}",
            "action": "setStatus",
            "status": "unsubscribed"
        }],
        "isSyncTriggeredOnImport": true,
        "dataRetentionDuration": "P7D",
        "autoDeleteDuration": "P30D",
        "isUpdatingMultipleMatchedRecords": false,
        "uri": "/emailAddresses/imports/4",
        "createdBy": "API.User",
        "createdAt": "2016-06-09T17:48:00.7500000Z",
        "updatedBy": "API.User",
        "updatedAt": "2016-06-09T17:49:20.3130000Z"
    }],
    "totalResults": 3,
    "limit": 1000,
    "offset": 0,
    "count": 3,
    "hasMore": false
}
			
Back to Top