Upload custom object sync action data

post

/api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data

Uploads custom object sync data for a specified custom object and sync action definition.

Request

Supported Media Types
Path Parameters
Body ()
The request body contains details of the custom object sync action definition.
Root Schema : CustomObjectSyncActionOperationData
Type: array
Title: CustomObjectSyncActionOperationData
Show Source
Nested Schema : CustomObjectSyncActionOperationDataItem
Type: object
Title: CustomObjectSyncActionOperationDataItem
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : CustomObjectSyncActionOperationDataResponse
Type: object
Title: CustomObjectSyncActionOperationDataResponse
Sync response when POSTing custom object sync action data, and isSyncTriggeredOnImport = true on the sync action definition.
Show Source
  • 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.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: SyncStatusType
    Default Value: pending
    Allowed Values: [ "pending", "active", "success", "warning", "error" ]
    The status of the synchronization. This is a read-only property.
  • 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.
  • Title: syncEndedAt
    The date and time the sync ended. This is a read-only property.
  • Title: syncStartedAt
    The date and time the sync started. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

204 Response

No content.

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 upload custom object sync action data using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Upload the custom object sync action data with a custom object id = 9 and a sync action id = 6, where isSyncTriggeredOnImport = false on the sync action definition:


POST /customObjects/9/syncActions/6/data
Content-Type: application/json 
			

Request body:


[
  {
    "Id": "DLPSB000000000020"
  },
  {
    "Id": "DLPSB000000000021"
  }
]
			

Response:


204 No Content
			

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 '[{"Id":"DLPSB000000000020"},{"Id":"DLPSB000000000021"}]' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/syncActions/6/data
			
Back to Top