Jump to

• Request
• Response
• Examples

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

• application/json
• text/csv

Path Parameters

• id(required): integer
• parentId(required): integer

Body ()

Root Schema : CustomObjectSyncActionOperationData

Type: array

Title: CustomObjectSyncActionOperationData

Show Source

• Array of: object CustomObjectSyncActionOperationDataItem
  Title: CustomObjectSyncActionOperationDataItem

{
    "title":"CustomObjectSyncActionOperationData",
    "type":"array",
    "items":{
        "title":"CustomObjectSyncActionOperationDataItem",
        "type":"object",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : CustomObjectSyncActionOperationDataItem

Type: object

Title: CustomObjectSyncActionOperationDataItem

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : CustomObjectSyncActionOperationDataResponse

Type: object

Title: CustomObjectSyncActionOperationDataResponse

Show Source

• callbackUrl: string
  Title: callbackUrl
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• status: string
  Title: SyncStatusType

  Default Value: pending

  Allowed Values: [ "pending", "active", "success", "warning", "error" ]
• syncedInstanceUri: string
  Title: syncedInstanceUri
• syncEndedAt: string(date-time)
  Title: syncEndedAt
• syncStartedAt: string(date-time)
  Title: syncStartedAt
• uri: string
  Title: uri

{
    "title":"CustomObjectSyncActionOperationDataResponse",
    "description":"",
    "properties":{
        "callbackUrl":{
            "title":"callbackUrl",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/SyncStatusType"
        },
        "syncedInstanceUri":{
            "title":"syncedInstanceUri",
            "description":"",
            "type":"string"
        },
        "syncEndedAt":{
            "format":"date-time",
            "title":"syncEndedAt",
            "description":"",
            "type":"string"
        },
        "syncStartedAt":{
            "format":"date-time",
            "title":"syncStartedAt",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

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