Create an import or export sync

post

/api/bulk/2.0/syncs

Creates an import or export sync.

Request

Supported Media Types
Body ()
The request body contains details about the synchronization definition.
Root Schema : SyncIndividual
Type: object
Title: SyncIndividual
The request body defines the details of the synchronization definition.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : SyncIndividualResponse
Type: object
Title: SyncIndividualResponse
The response body includes information about the synchronization definition.
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 new sync using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Create a new sync for the export definition with id = 7:


POST /syncs
Content-Type: application/json 
			

Request body:


{
   "syncedInstanceUri" : "/activities/exports/7",
   "callbackURL" : "http://www.example.com"
}
			

Note:

The callback can occur during sync creation, before the sync creation response, or immediately after.

Response:


{
    "syncedInstanceUri":"/activities/exports/7",
    "callbackUrl":"http://www.example.com",
    "status":"pending",
    "createdAt":"2015-09-25T18:08:32.3485942Z",
    "createdBy":"API.User",
    "uri":"/syncs/66100"
}
			

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 '{"syncedInstanceUri":"/activities/exports/7","callbackURL":"http://www.example.com"}' https://secure.p03.eloqua.com/api/bulk/2.0/syncs
			
Back to Top