Update an email address import definition

put

/api/bulk/2.0/emailAddresses/imports/{id}

Updates an email address import definition. For PUT requests, the parameters below are required for validation, even if they are not changing.

Request

Supported Media Types
Path Parameters
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

200 Response

OK.
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

Update the email address import definition with the id = 3:


PUT /emailAddresses/imports/3
Content-Type: application/json 
			

Request body:


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

Response:


{
    "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.2442580Z"
}
			
Back to Top