1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Bulk
  4. 2.0
  5. accounts

Create an account sync action definition

post

/api/bulk/2.0/accounts/syncActions

Creates a new account sync action definition.

Request

Supported Media Types
Body ()
The request body defines details of the account sync action definition.
Root Schema : AccountSyncActionOperationIndividual
Type: object
Title: AccountSyncActionOperationIndividual
The request body defines the details of the account sync action definition.
Show Source
  • 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 sync action. This is a read-only property.
  • fields
    Title: fields
    The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
  • Title: identifierFieldName
    The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
  • Title: isSyncTriggeredOnImport
    Whether or not the sync is triggered upon uploading data.
  • Title: kbUsed
    The amount of space used in kb. This is a read-only property.
  • Title: name
    The name of the sync action definition.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. 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.
Nested Schema : fields
Type: object
Title: fields
The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : AccountSyncActionOperationIndividualResponse
Type: object
Title: AccountSyncActionOperationIndividualResponse
The response body includes information about the account sync action definition.
Show Source
  • 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 sync action. This is a read-only property.
  • fields
    Title: fields
    The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
  • Title: identifierFieldName
    The field which will be used to identify the entity. Must be a string value, at least 1 character and at most 100 characters long.
  • Title: isSyncTriggeredOnImport
    Whether or not the sync is triggered upon uploading data.
  • Title: kbUsed
    The amount of space used in kb. This is a read-only property.
  • Title: name
    The name of the sync action definition.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. 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.
Nested Schema : fields
Type: object
Title: fields
The field name and statement that will be used to identify the account, contact, or custom object. Must contain only one field. Allowed field statement values to identify a contact are: {{Contact.Field(C_EmailAddress)}}, {{Contact.Field(ContactIDExt)}}, or {{Contact.Id}}. Allowed field statement values to identify an account are: {{Account.Field(CompanyIDExt)}}, {{Account.Field(M_CompanyName)}}, or {{Account.Id}}. Allowed field statement values to identify a custom object are: {{CustomObject[{id}].ExternalId}}.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center. There currently are not any sync actions available for Events.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.

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

HTTP Request Example

Create a new account sync action definition:


POST /api/bulk/2.0/accounts/syncActions
Content-Type: application/json

Request body:


{  
   "name":"Bulk Sync Action",
   "fields":{  
      "Name":"{{Account.Field(M_CompanyName)}}"
   },
   "identifierFieldName":"Name",
   "syncActions":[  
      {  
         "destination":"{{AccountList[1]}}",
         "action":"add"
      }
   ],
   "isSyncTriggeredOnImport":false
}

Response:


{  
   "name":"Bulk Sync Action",
   "fields":{  
      "Name":"{{Account.Field(M_CompanyName)}}"
   },
   "identifierFieldName":"Name",
   "syncActions":[  
      {  
         "destination":"{{AccountList[1]}}",
         "action":"add"
      }
   ],
   "isSyncTriggeredOnImport":false,
   "uri":"/accounts/syncActions/622",
   "createdBy":"API.User",
   "createdAt":"2016-01-13T21:31:31.6226913Z",
   "updatedBy":"API.User",
   "updatedAt":"2016-01-13T21:31:31.6226913Z"
}

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","fields":{"Name":"{{Account.Field(M_CompanyName)}}"},"identifierFieldName":"Name","syncActions":[{"destination":"{{AccountList[1]}}","action":"add"}],"isSyncTriggeredOnImport":false}' https://secure.p03.eloqua.com/api/bulk/2.0/accounts/syncActions
Back to Top