openapi: 3.2.0 info: title: REST API for Oracle Eloqua Marketing Cloud Service Bulk/2.0/accounts API description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. version: 2026.08.07 x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. tags: - name: Bulk/2.0/accounts description: The operations from the Bulk/2.0/accounts category. paths: /api/bulk/2.0/accounts/exports: get: tags: - Bulk/2.0/accounts summary: Retrieve a list of account export definitions description: Retrieves a list of account export definitions. operationId: GetAccountExportSearch parameters: - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: orderBy in: query description: 'Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.' schema: type: string - name: q in: query description: 'A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".' schema: type: string - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountExportSearchResponse description: The response body contains information about the account export definitions. properties: count: title: count description: Number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: $ref: '#/components/schemas/Export' limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-get x-filename-id: api-bulk-2.0-accounts-exports-get post: tags: - Bulk/2.0/accounts summary: Create an account export definition description: Creates a new account export definition. After a successful request, the next step is to synchronize the data. See the tutorial for details on how to export data. operationId: PostAccountExportIndividual responses: '201': description: Success. content: application/json: schema: title: AccountExportIndividualResponse description: The response body includes information about the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-post x-filename-id: api-bulk-2.0-accounts-exports-post requestBody: content: application/json: schema: title: AccountExportIndividual description: The request body defines the details of the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountExportIndividual description: The request body defines the details of the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body contains details of the account export definition. required: true /api/bulk/2.0/accounts/exports/{id}: get: tags: - Bulk/2.0/accounts summary: Retrieve an account export definition description: Retrieves an account export definition. operationId: GetAccountExportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account export. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountExportIndividualResponse description: The response body includes information about the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-{id}-get x-filename-id: api-bulk-2.0-accounts-exports-id-get put: tags: - Bulk/2.0/accounts summary: Update an account export definition description: Updates an account export definition. operationId: PutAccountExportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account export. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountExportIndividualResponse description: The response body includes information about the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-{id}-put x-filename-id: api-bulk-2.0-accounts-exports-id-put requestBody: content: application/json: schema: title: AccountExportIndividual description: The request body defines the details of the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountExportIndividual description: The request body defines the details of the account export definition. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body contains details of the account export definition. required: true delete: tags: - Bulk/2.0/accounts summary: Delete an account export definition description: Deletes an account export definition. operationId: DeleteAccountExportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account export. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-{id}-delete x-filename-id: api-bulk-2.0-accounts-exports-id-delete /api/bulk/2.0/accounts/exports/{id}/data: get: tags: - Bulk/2.0/accounts summary: Retrieve an account export definition's synced data description: Retrieves an account export definition's synced data. operationId: GetAccountExportDataQuery parameters: - name: id in: path description: Part of the uri used to identify the account export. required: true schema: type: integer - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountExportDataQueryResponse description: Query response when retrieving account export data. properties: count: title: count description: The number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: type: object limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-{id}-data-get x-filename-id: api-bulk-2.0-accounts-exports-id-data-get delete: tags: - Bulk/2.0/accounts summary: Delete an account export definition's data description: Deletes an account export definition's data. operationId: DeleteAccountExportDataQuery parameters: - name: id in: path description: Part of the uri used to identify the account export. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-exports-{id}-data-delete x-filename-id: api-bulk-2.0-accounts-exports-id-data-delete /api/bulk/2.0/accounts/fields/{id}: get: tags: - Bulk/2.0/accounts summary: Retrieve an account field definition description: Retrieves an account field definition. operationId: GetAccountFieldIndividual parameters: - name: id in: path description: Part of the uri used to identify the account field. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountFieldIndividualResponse description: The response body contains information about the account field definition. properties: createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataType: $ref: '#/components/schemas/DataType' defaultValue: title: defaultValue description: The field's default value. type: string hasNotNullConstraint: title: hasNotNullConstraint description: Indicates whether the field can have null values (i.e. empty). type: boolean hasReadOnlyConstraint: title: hasReadOnlyConstraint description: Indicates whether the field can be written to. type: boolean hasUniquenessConstraint: title: hasUniquenessConstraint description: Indicates whether the field must have a unique value. type: boolean internalName: title: internalName description: The field's internal name (used to uniquely identify it). type: string name: title: name description: The name of the account definition. type: string statement: title: statement description: The markup language statement used to reference the field in an import or export mapping. type: string updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-fields-{id}-get x-filename-id: api-bulk-2.0-accounts-fields-id-get /api/bulk/2.0/accounts/fields: get: tags: - Bulk/2.0/accounts summary: Retrieve a list of account field definitions description: Retrieves a list of account field definitions. operationId: GetAccountFieldSearch parameters: - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: orderBy in: query description: 'Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.' schema: type: string - name: q in: query description: 'A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".' schema: type: string - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountFieldSearchResponse description: The response body contains information about the account field definitions. properties: count: title: count description: Number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: $ref: '#/components/schemas/AccountField' limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-fields-get x-filename-id: api-bulk-2.0-accounts-fields-get /api/bulk/2.0/accounts/imports: get: tags: - Bulk/2.0/accounts summary: Retrieve a list of account import definitions description: Retrieves a list of account import definitions. operationId: GetAccountImportSearch parameters: - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: orderBy in: query description: 'Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.' schema: type: string - name: q in: query description: 'A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".' schema: type: string - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountImportSearchResponse description: The response body contains information about account import definitions. properties: count: title: count description: Number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: $ref: '#/components/schemas/Import' limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The actual index from which the records are returned. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-get x-filename-id: api-bulk-2.0-accounts-imports-get post: tags: - Bulk/2.0/accounts summary: Create an account import definition description: Creates a new account import definition. See the tutorial for details on how to import data. operationId: PostAccountImportIndividual responses: '201': description: Success. content: application/json: schema: title: AccountImportIndividualResponse description: The response body includes information about the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-post x-filename-id: api-bulk-2.0-accounts-imports-post requestBody: content: application/json: schema: title: AccountImportIndividual description: The request body defines the details of the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountImportIndividual description: The request body defines the details of the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body contains details of the account import definition. required: true /api/bulk/2.0/accounts/imports/{id}: get: tags: - Bulk/2.0/accounts summary: Retrieve an account import definition description: Retrieves an account import definition. operationId: GetAccountImportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account import. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountImportIndividualResponse description: The response body includes information about the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-{id}-get x-filename-id: api-bulk-2.0-accounts-imports-id-get put: tags: - Bulk/2.0/accounts summary: Update an account import definition description: Updates an account import definition. operationId: PutAccountImportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account import. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountImportIndividualResponse description: The response body includes information about the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-{id}-put x-filename-id: api-bulk-2.0-accounts-imports-id-put requestBody: content: application/json: schema: title: AccountImportIndividual description: The request body defines the details of the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountImportIndividual description: The request body defines the details of the account import definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer linkUsers: title: linkUsers description: 'A boolean parameter that enables you to link Eloqua Users to Accounts during an Account import by specifying a CRM User ID. If set to true, one of the following CRM User ID fields is required in the Account import definition: CRMOSCUserId, CRMSfdcUserId, CRMMSDUserId, or CRMSODUserId. Refer to the linkUsers parameter in this tutorial for an example.' type: boolean name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body contains details of the account import definition. required: true delete: tags: - Bulk/2.0/accounts summary: Delete an account import definition description: Deletes an account import definition. operationId: DeleteAccountImportIndividual parameters: - name: id in: path description: Part of the uri used to identify the account import. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-{id}-delete x-filename-id: api-bulk-2.0-accounts-imports-id-delete /api/bulk/2.0/accounts/imports/{id}/data: post: tags: - Bulk/2.0/accounts summary: Upload data for a specified account import definition description: Uploads data for a specified account import definition. For more information on uploading Account data, see the tutorial. When uploading data, Eloqua expects that data to be encoded with UTF-8. operationId: PostAccountImportData parameters: - name: id in: path description: Part of the uri used to identify the account import. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: AccountImportDataResponse description: Sync response when POSTing account import data, and isSyncTriggeredOnImport = true on the import definition. properties: callbackUrl: title: callbackUrl description: 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. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string status: $ref: '#/components/schemas/SyncStatusType' syncedInstanceUri: title: syncedInstanceUri description: 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. type: string syncEndedAt: format: date-time title: syncEndedAt description: The date and time the sync ended. This is a read-only property. type: string syncStartedAt: format: date-time title: syncStartedAt description: The date and time the sync started. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '204': description: No content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-{id}-data-post x-filename-id: api-bulk-2.0-accounts-imports-id-data-post requestBody: content: application/json: schema: title: AccountImportData type: array items: title: AccountImportDataItem type: object items: type: string text/csv: schema: title: AccountImportData type: array items: title: AccountImportDataItem type: object items: type: string description: The request body contains data to be uploaded to the account import definition. required: true delete: tags: - Bulk/2.0/accounts summary: Delete an account import definition's data description: Deletes an account import definition's data. operationId: DeleteAccountImportData parameters: - name: id in: path description: Part of the uri used to identify the account import. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-imports-{id}-data-delete x-filename-id: api-bulk-2.0-accounts-imports-id-data-delete /api/bulk/2.0/accounts/lists/{id}: get: tags: - Bulk/2.0/accounts summary: Retrieve an account list definition description: Retrieves an account list definition. operationId: GetAccountListIndividual parameters: - name: id in: path description: The account field definition's unique resource identifier. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: AccountListIndividualResponse description: The response body contains information about the account list definition. properties: count: title: count description: Number of results returned in the request. type: integer createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string name: title: name description: The name of the account definition. type: string statement: title: statement description: The markup language statement used to reference the field in an import or export mapping. type: string updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-lists-{id}-get x-filename-id: api-bulk-2.0-accounts-lists-id-get /api/bulk/2.0/accounts/lists: get: tags: - Bulk/2.0/accounts summary: Retrieve a list of account list definitions description: Retrieves a list of account list definitions. operationId: GetAccountListSearch parameters: - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: orderBy in: query description: 'Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.' schema: type: string - name: q in: query description: 'A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".' schema: type: string - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountListSearchResponse description: The response body contains information about the account list definitions. properties: count: title: count description: Number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: $ref: '#/components/schemas/AccountList' limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The actual index from which the records are returned. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-lists-get x-filename-id: api-bulk-2.0-accounts-lists-get /api/bulk/2.0/accounts/syncActions: get: tags: - Bulk/2.0/accounts summary: Retrieve a list of account sync action definitions description: Retrieves a list of account sync action definitions. operationId: GetAccountSyncActionOperationSearch parameters: - name: limit in: query description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: ?limit=5.' schema: type: integer - name: links in: query description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next. schema: type: string - name: offset in: query description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.' schema: type: integer - name: orderBy in: query description: 'Specifies the name of the property to order the results by. The orderBy format is term ASC | DESC. Example: ?orderBy=name ASC.' schema: type: string - name: q in: query description: 'A URL parameter that specifies query criteria used to filter results. The q format is termoperatorvalue. Use "*" for wildcard values. Example: ?q="name=*Test*" will find all the entities where the "name" field contains the string "Test".' schema: type: string - name: totalResults in: query description: Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true. schema: type: boolean responses: '200': description: OK. content: application/json: schema: title: AccountSyncActionOperationSearchResponse description: The response body contains information about the sync action definitions. properties: count: title: count description: Number of results returned in the request. type: integer hasMore: title: hasMore description: Indicates if there are more results. type: boolean items: title: items description: The collection of items that match the search. type: array items: $ref: '#/components/schemas/SyncActionOperation' limit: title: limit description: The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified. type: integer offset: title: offset description: The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified. type: integer totalResults: format: int64 title: totalResults description: Number of total results. Returned when the totalResults URL parameter is not set to false. type: integer '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-get x-filename-id: api-bulk-2.0-accounts-syncactions-get post: tags: - Bulk/2.0/accounts summary: Create an account sync action definition description: Creates a new account sync action definition. operationId: PostAccountSyncActionOperationIndividual responses: '201': description: Success. content: application/json: schema: title: AccountSyncActionOperationIndividualResponse description: The response body includes information about the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-post x-filename-id: api-bulk-2.0-accounts-syncactions-post requestBody: content: application/json: schema: title: AccountSyncActionOperationIndividual description: The request body defines the details of the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountSyncActionOperationIndividual description: The request body defines the details of the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body defines details of the account sync action definition. required: true /api/bulk/2.0/accounts/syncActions/{id}: get: tags: - Bulk/2.0/accounts summary: Retrieve an account sync action definition description: Retrieves an account sync action definition. operationId: GetAccountSyncActionOperationIndividual parameters: - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '200': description: Success. content: application/json: schema: title: AccountSyncActionOperationIndividualResponse description: The response body includes information about the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-{id}-get x-filename-id: api-bulk-2.0-accounts-syncactions-id-get put: tags: - Bulk/2.0/accounts summary: Update an account sync action definition description: Updates an account sync action definition. For PUT requests, the parameters below are required for validation, even if they are not changing. operationId: PutAccountSyncActionOperationIndividual parameters: - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '200': description: Success. content: application/json: schema: title: AccountSyncActionOperationIndividualResponse description: The response body includes information about the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-{id}-put x-filename-id: api-bulk-2.0-accounts-syncactions-id-put requestBody: content: application/json: schema: title: AccountSyncActionOperationIndividual description: The request body defines the details of the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string text/csv: schema: title: AccountSyncActionOperationIndividual description: The request body defines the details of the account sync action definition. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string description: The request body defines details of the account sync action definition. required: true delete: tags: - Bulk/2.0/accounts summary: Delete an account sync action definition description: Deletes the specified account sync action definition. operationId: DeleteAccountSyncActionOperationIndividual parameters: - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-{id}-delete x-filename-id: api-bulk-2.0-accounts-syncactions-id-delete /api/bulk/2.0/accounts/syncActions/{id}/data: post: tags: - Bulk/2.0/accounts summary: Upload account sync action data description: Uploads account sync action data. operationId: PostAccountSyncActionOperationData parameters: - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: AccountSyncActionOperationDataResponse description: Sync response when POSTing account sync action data, and isSyncTriggeredOnImport = true on the sync action definition. properties: callbackUrl: title: callbackUrl description: 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. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string status: $ref: '#/components/schemas/SyncStatusType' syncedInstanceUri: title: syncedInstanceUri description: 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. type: string syncEndedAt: format: date-time title: syncEndedAt description: The date and time the sync ended. This is a read-only property. type: string syncStartedAt: format: date-time title: syncStartedAt description: The date and time the sync started. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string '204': description: No content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-{id}-data-post x-filename-id: api-bulk-2.0-accounts-syncactions-id-data-post requestBody: content: application/json: schema: title: AccountSyncActionOperationData type: array items: title: AccountSyncActionOperationDataItem type: object items: type: string text/csv: schema: title: AccountSyncActionOperationData type: array items: title: AccountSyncActionOperationDataItem type: object items: type: string description: The request body contains details of the account sync action data. required: true delete: tags: - Bulk/2.0/accounts summary: Delete sync data for an account sync action definition description: Deletes sync data for an account sync action definition. operationId: DeleteAccountSyncActionOperationData parameters: - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '204': description: No Content. '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: There was a conflict. See Status Codes for information about other possible HTTP status codes. '410': description: The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes. '412': description: 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': description: Storage space exceeded. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes. '503': description: There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes. deprecated: false x-internal-id: api-bulk-2.0-accounts-syncActions-{id}-data-delete x-filename-id: api-bulk-2.0-accounts-syncactions-id-data-delete components: schemas: SyncAction: title: SyncAction description: The definition of the action to take at time of syncronization. properties: action: $ref: '#/components/schemas/SyncActionType' destination: title: destination description: The ML statement used to reference an object used by the action. type: string status: $ref: '#/components/schemas/MemberStatus' updateAll: title: updateAll description: Update status of all records in an execution. type: boolean Import: title: Import description: The request body defines the details of the import definition. The following table displays properties for creating import definitions. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time that unsync'd data from this import should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to P7D (7 days) if not explicitly set during import definition creation. type: string externalSystemId: title: externalSystemId description: The id of the external system. type: integer fields: title: fields description: List of fields to be included in the operation. type: object identifierFieldName: title: identifierFieldName description: '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. The following field types are not supported: Large Text, Date, and Boolean.' type: string importPriorityUri: title: importPriorityUri description: Must reference an existing /imports/priorities/{id}. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string importRule: $ref: '#/components/schemas/ImportRuleType' isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered on import. type: boolean isUpdatingMultipleMatchedRecords: title: isUpdatingMultipleMatchedRecords description: Whether or not imported data will be mapped to multiple existing records. For contact imports, the isUpdatingMultipleMatchedRecords property must be set to false to update Contact.Field(C_EmailAddress). type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer name: title: name description: The name of the import definition. type: string nullIdentifierFieldName: title: nullIdentifierFieldName description: Whether or not to null the identifier field. type: boolean syncActions: title: syncActions description: '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.' type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string updateRule: $ref: '#/components/schemas/RuleType' updateRuleByField: title: updateRuleByField description: The rule by field used when doing updates on existing data. Each pair is a field name mapped to a rule type. type: object uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string MemberStatus: title: MemberStatus description: The status of members. default: bounced enum: - bounced - subscribed - unsubscribed - active - complete - pending - errored - 'yes' - 'no' - invalid - permission type: string RuleType: title: RuleType description: The rule used when doing updates on existing data. For more information about this parameter, see the Oracle Eloqua Developer Help Center. default: always enum: - always - ifNewIsNotNull - ifExistingIsNull - useFieldRule type: string SyncActionType: title: SyncActionType description: The action to take at time of synchronization. default: add enum: - add - remove - setStatus type: string DataType: title: DataType description: The type of data, used for field definitions. default: number enum: - number - string - boolean - date - emailAddress type: string AccountList: title: AccountList description: The response body contains information about the account list definition. properties: count: title: count description: Number of results returned in the request. type: integer createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string name: title: name description: The name of the account definition. type: string statement: title: statement description: The markup language statement used to reference the field in an import or export mapping. type: string updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string Export: title: Export description: The request body defines the details of the export definition. The following table displays properties for creating export definitions. properties: areSystemTimestampsInUTC: title: areSystemTimestampsInUTC description: Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true. type: boolean autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string crmAccountIdField: title: crmAccountIdField description: The ML statement for an existing contact field which addresses the CRM account ID. type: string dataRetentionDuration: title: dataRetentionDuration description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation. type: string externalSystemId: title: externalSystemId description: The external system ID is used when exporting data containing CRM fields. type: integer fields: title: fields description: List of fields to be included in the operation. type: object filter: title: filter description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters. type: string kbUsed: format: int64 title: kbUsed description: The amount of space used in kilobytes. This is a read-only property. type: integer maxRecords: title: maxRecords description: The maximum amount of records. type: integer name: title: name description: The name of the export definition. type: string productIdField: title: productIdField description: The ML statement for an existing campaign field which addresses the product ID. type: string syncActions: title: syncActions description: 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. type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string AccountField: title: AccountField description: The definition of a field on all accounts in the system. properties: createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the entity. This is a read-only property. type: string dataType: $ref: '#/components/schemas/DataType' defaultValue: title: defaultValue description: The field's default value. type: string hasNotNullConstraint: title: hasNotNullConstraint description: Indicates whether the field can have null values (i.e. empty). type: boolean hasReadOnlyConstraint: title: hasReadOnlyConstraint description: Indicates whether the field can be written to. type: boolean hasUniquenessConstraint: title: hasUniquenessConstraint description: Indicates whether the field must have a unique value. type: boolean internalName: title: internalName description: The field's internal name (used to uniquely identify it). type: string name: title: name description: The name of the account definition. type: string statement: title: statement description: The markup language statement used to reference the field in an import or export mapping. type: string updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string SyncActionOperation: title: SyncActionOperation description: The request body defines the details of the sync action definition. The following table displays properties for creating sync action definitions. properties: autoDeleteDuration: title: autoDeleteDuration description: Time until the definition will be deleted, expressed using the ISO-8601 standard. type: string createdAt: format: date-time title: createdAt description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. type: string createdBy: title: createdBy description: The login id of the user who created the sync action. This is a read-only property. type: string fields: title: fields description: '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}}.' type: object identifierFieldName: title: identifierFieldName description: 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. type: string isSyncTriggeredOnImport: title: isSyncTriggeredOnImport description: Whether or not the sync is triggered upon uploading data. type: boolean kbUsed: format: int64 title: kbUsed description: The amount of space used in kb. This is a read-only property. type: integer name: title: name description: The name of the sync action definition. type: string syncActions: title: syncActions description: "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. \nThere currently are not any sync actions available for Events." type: array items: $ref: '#/components/schemas/SyncAction' updatedAt: format: date-time title: updatedAt description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property. type: string updatedBy: title: updatedBy description: The login id of the user that last updated the entity. This is a read-only property. type: string uri: title: uri description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property. type: string ImportRuleType: title: ImportRuleType description: Import.ImportRuleType_Description default: createAndUpdate enum: - createAndUpdate - updateOnly - createOnly type: string SyncStatusType: title: SyncStatusType description: The status of the synchronization. This is a read-only property. default: pending enum: - pending - active - success - warning - error type: string