Jump to

• Request
• Response
• Examples

Create an account import definition

post

/api/bulk/2.0/accounts/imports

Creates a new account import definition. See the tutorial for details on how to import data.

Request

Supported Media Types

• application/json
• text/csv

Body ()

Root Schema : AccountImportIndividual

Type: object

Title: AccountImportIndividual

Show Source

• autoDeleteDuration: string
  Title: autoDeleteDuration
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• dataRetentionDuration: string
  Title: dataRetentionDuration
• externalSystemId: integer
  Title: externalSystemId
• fields: object fields
  Title: fields
• identifierFieldName: string
  Title: identifierFieldName
• importPriorityUri: string
  Title: importPriorityUri
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed: integer(int64)
  Title: kbUsed
• linkUsers: boolean
  Title: linkUsers
• name: string
  Title: name
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName
• syncActions: array syncActions
  Title: syncActions
• updatedAt: string(date-time)
  Title: updatedAt
• updatedBy: string
  Title: updatedBy
• updateRule: string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField
• uri: string
  Title: uri

{
    "title":"AccountImportIndividual",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "linkUsers":{
            "title":"linkUsers",
            "description":"",
            "type":"boolean"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncAction"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: object SyncAction
  Title: SyncAction

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncAction"
    }
}

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

Nested Schema : SyncAction

Type: object

Title: SyncAction

Show Source

• action: string
  Title: SyncActionType

  Default Value: add

  Allowed Values: [ "add", "remove", "setStatus" ]
• destination: string
  Title: destination
• status: string
  Title: MemberStatus

  Default Value: bounced

  Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
• updateAll: boolean
  Title: updateAll

{
    "title":"SyncAction",
    "description":"",
    "properties":{
        "action":{
            "$ref":"#/definitions/SyncActionType"
        },
        "destination":{
            "title":"destination",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/MemberStatus"
        },
        "updateAll":{
            "title":"updateAll",
            "description":"",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : AccountImportIndividualResponse

Type: object

Title: AccountImportIndividualResponse

Show Source

• autoDeleteDuration: string
  Title: autoDeleteDuration
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• dataRetentionDuration: string
  Title: dataRetentionDuration
• externalSystemId: integer
  Title: externalSystemId
• fields: object fields
  Title: fields
• identifierFieldName: string
  Title: identifierFieldName
• importPriorityUri: string
  Title: importPriorityUri
• isSyncTriggeredOnImport: boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords: boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed: integer(int64)
  Title: kbUsed
• linkUsers: boolean
  Title: linkUsers
• name: string
  Title: name
• nullIdentifierFieldName: boolean
  Title: nullIdentifierFieldName
• syncActions: array syncActions
  Title: syncActions
• updatedAt: string(date-time)
  Title: updatedAt
• updatedBy: string
  Title: updatedBy
• updateRule: string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField: object updateRuleByField
  Title: updateRuleByField
• uri: string
  Title: uri

{
    "title":"AccountImportIndividualResponse",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "linkUsers":{
            "title":"linkUsers",
            "description":"",
            "type":"boolean"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncAction"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"object"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: object SyncAction
  Title: SyncAction

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncAction"
    }
}

Nested Schema : updateRuleByField

Type: object

Title: updateRuleByField

Nested Schema : SyncAction

Type: object

Title: SyncAction

Show Source

• action: string
  Title: SyncActionType

  Default Value: add

  Allowed Values: [ "add", "remove", "setStatus" ]
• destination: string
  Title: destination
• status: string
  Title: MemberStatus

  Default Value: bounced

  Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
• updateAll: boolean
  Title: updateAll

{
    "title":"SyncAction",
    "description":"",
    "properties":{
        "action":{
            "$ref":"#/definitions/SyncActionType"
        },
        "destination":{
            "title":"destination",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/MemberStatus"
        },
        "updateAll":{
            "title":"updateAll",
            "description":"",
            "type":"boolean"
        }
    }
}

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

The following examples demonstrate how to create a new account import definition using an HTTP request and cURL. For more information on requests, see API requests. See the tutorial for details on how to import data.

HTTP Request Example

Create a new account import definition to import a list of account company names:

POST /api/bulk/2.0/accounts/imports
Content-Type: application/json 
			

Request body:

{
   "name":"Account Company Name Import",
   "fields":{
      "CompanyName":"{{Account.Field(M_CompanyName)}}"
   },
  "identifierFieldName": "CompanyName",
}
			

Response:

{
    "name":"Account Company Name Import",
    "fields":{
        "CompanyName":"{{Account.Field(M_CompanyName)}}"
    },
    "identifierFieldName":"CompanyName",
    "isSyncTriggeredOnImport":false,
    "dataRetentionDuration":"P7D",
    "isUpdatingMultipleMatchedRecords":false,
    "uri":"/accounts/imports/29298",
    "createdBy":"Api.User",
    "createdAt":"2015-08-17T20:02:48.8708817Z",
    "updatedBy":"Api.User",
    "updatedAt":"2015-08-17T20:02:48.8708817Z"
}
			

Note:

When retrieving the field M_CompanyName, the hasNotNullConstraint will return true, where it should return false. The M_CompanyName field can be null.

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.

curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"name":"Account Company Name Import","fields":{"CompanyName":"{{Account.Field(M_CompanyName)}}"},"identifierFieldName":"CompanyName",}' https://secure.p03.eloqua.com/api/bulk/2.0/accounts/imports
			

Back to Top