Create a custom object sync action definition

post

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

Creates a new custom object sync action definition.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : CustomObjectSyncActionOperationIndividual
Type: object
Title: CustomObjectSyncActionOperationIndividual
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : CustomObjectSyncActionOperationIndividualResponse
Type: object
Title: CustomObjectSyncActionOperationIndividualResponse
Show Source
Nested Schema : fields
Type: array
Title: fields
Show Source
Nested Schema : syncActions
Type: array
Title: syncActions
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

The following examples demonstrate how to create a custom object sync action definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new custom object sync action definition for the custom object with id = 1738:


POST /customObjects/1738/syncActions
Content-Type: application/json 
			

Request body:


{
    "name": "Bulk Sync Action - Custom Object",
    "fields": {
        "Id": "{{CustomObject[1738].ExternalId}}"
    },
    "identifierFieldName": "Id",
    "syncActions": [{
        "action": "setStatus",
        "destination": "{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}",
        "status": "active"
    }],
    "isSyncTriggeredOnImport": false
}
			

Response:


{
    "id": 6,
    "parentId": 1738,
    "name": "Bulk Sync Action - Custom Object",
    "fields": {
        "Id": "{{CustomObject[1738].ExternalId}}"
    },
    "identifierFieldName": "Id",
    "syncActions": [{
        "destination": "{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}",
        "action": "setStatus",
        "status": "active"
    }],
    "isSyncTriggeredOnImport": false,
    "uri": "/customObjects/1738/syncActions/6",
    "createdBy": "API.User",
    "createdAt": "2016-06-03T19:04:29.1835609Z",
    "updatedBy": "API.User",
    "updatedAt": "2016-06-03T19:04:29.1835609Z"
}
			

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":"Bulk Sync Action - Custom Object","fields":{"Id":"{{CustomObject[1738].ExternalId}}"},"identifierFieldName":"Id","syncActions":[{"action":"setStatus","destination":"{{ActionInstance(0122fdcfd3544a1c8c96ed58fcf4c1c3).Execution[11]}}","status":"active"}],"isSyncTriggeredOnImport":false}' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/1738/syncActions
			
Back to Top