Create an email address import definition

post

/api/bulk/2.0/emailAddresses/imports

Creates a new email address import definition. The Bulk API's emailAddresses import allows you to change the global subscription status of email addresses without having to create a contact. The global subscription status can only be changed to unsubscribed. When an email address is imported this way, any present or future contact in Eloqua with the same email address will be automatically globally unsubscribed. Alternatively, to globally subscribe an email address, the /contacts/imports and /contacts/exports endpoints can be used with a sync action.

Request

Supported Media Types
Body ()
Root Schema : EmailAddressImportIndividual
Type: object
Title: EmailAddressImportIndividual
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
Show Source
Nested Schema : updateRuleByField
Type: array
Title: updateRuleByField
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : EmailAddressImportIndividualResponse
Type: object
Title: EmailAddressImportIndividualResponse
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
Show Source
Nested Schema : updateRuleByField
Type: array
Title: updateRuleByField
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

Create a new email address import definition.


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

Request body:


{  
   "name":"Test Import",
   "fields":{  
      "UnsubEmail":"{{EmailAddress.Field(EmailAddress)}}"
   },
   "identifierFieldName":"UnsubEmail",
   "isSyncTriggeredOnImport":false,
   "syncActions":[  
      {  
         "destination":"{{GlobalSubscribe}}",
         "action":"setStatus",
         "status":"unsubscribed"
      }
   ]
}
			

Response:


{  
   "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/33310",
   "createdBy":"API.User",
   "createdAt":"2015-09-28T14:26:46.7395963Z",
   "updatedBy":"API.User",
   "updatedAt":"2015-09-28T14:26:46.7395963Z"
}
			
Back to Top