Jump to

• Request
• Response

Upload data for a specified phone number import definition

post

/api/bulk/2.0/phoneNumbers/imports/{id}/data

Uploads data for a specified phone number import definition. For more information on uploading phone number data, see the tutorial. When uploading data, Eloqua expects that data to be encoded with UTF-8.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  The phone number import definition's resource identification number.

Body ()

The request body contains data to be uploaded to the phone number import definition.

Root Schema : PhoneNumberImportData

Type: array

Title: PhoneNumberImportData

Show Source

• Array of: object PhoneNumberImportDataItem
  Title: PhoneNumberImportDataItem

{
    "title":"PhoneNumberImportData",
    "type":"array",
    "items":{
        "title":"PhoneNumberImportDataItem",
        "type":"object",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : PhoneNumberImportDataItem

Type: object

Title: PhoneNumberImportDataItem

Show Source

• Array of: string

{
    "title":"PhoneNumberImportDataItem",
    "type":"object",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : PhoneNumberImportDataResponse

Type: object

Title: PhoneNumberImportDataResponse

Sync response when POSTing phone number import data, and isSyncTriggeredOnImport = true on the import definition.

Show Source

• callbackUrl: string
  Title: callbackUrl

  When a sync completes, Eloqua will make a call to the URL specified in this parameter. The callback can occur during sync creation, before the sync creation response, or immediately after.
• createdAt: string(date-time)
  Title: createdAt

  The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• status: string
  Title: SyncStatusType

  Default Value: pending

  Allowed Values: [ "pending", "active", "success", "warning", "error" ]

  The status of the synchronization. This is a read-only property.
• syncedInstanceUri: string
  Title: syncedInstanceUri

  This value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a "uri" parameter, the value of which should be used here.
• syncEndedAt: string(date-time)
  Title: syncEndedAt

  The date and time the sync ended. This is a read-only property.
• syncStartedAt: string(date-time)
  Title: syncStartedAt

  The date and time the sync started. This is a read-only property.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"PhoneNumberImportDataResponse",
    "description":"Sync response when POSTing phone number import data, and isSyncTriggeredOnImport = true on the import definition.",
    "properties":{
        "callbackUrl":{
            "title":"callbackUrl",
            "description":"When a sync completes, Eloqua will make a call to the URL specified in this parameter. The callback can occur during sync creation, before the sync creation response, or immediately after.",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/SyncStatusType"
        },
        "syncedInstanceUri":{
            "title":"syncedInstanceUri",
            "description":"This value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a \"uri\" parameter, the value of which should be used here.",
            "type":"string"
        },
        "syncEndedAt":{
            "format":"date-time",
            "title":"syncEndedAt",
            "description":"The date and time the sync ended. This is a read-only property.",
            "type":"string"
        },
        "syncStartedAt":{
            "format":"date-time",
            "title":"syncStartedAt",
            "description":"The date and time the sync started. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

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