openapi: 3.2.0 info: title: REST API for Oracle Eloqua Marketing Cloud Service Bulk/2.0/custom Objects 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/customObjects description: The operations from the Bulk/2.0/customObjects category. paths: /api/bulk/2.0/customObjects/{parentId}: get: tags: - Bulk/2.0/customObjects summary: Retrieve a custom object description: Retrieves a custom object that matches the criteria specified in the URL parameters. operationId: GetCustomObjectIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectIndividualResponse description: The response body contains information about the custom object 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 displayNameFieldUri: title: displayNameFieldUri description: The relative uri used to reference the custom object field that represents the display field, for this custom object. type: string emailAddressFieldUri: title: emailAddressFieldUri description: The relative uri used to reference the custom object field that represents an email address, for this custom object. type: string name: title: name description: The name of the custom object definition. type: string uniqueFieldUri: title: uniqueFieldUri description: The relative uri used to reference the custom object field that has a uniqueness constraint on it, for this custom object. 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-customObjects-{parentId}-get x-filename-id: api-bulk-2.0-customobjects-parentid-get /api/bulk/2.0/customObjects/{parentId}/exports: get: tags: - Bulk/2.0/customObjects summary: Retrieve a list of export definitions for a custom object description: Retrieves the list of export definitions for the custom object with the specified id operationId: GetCustomObjectExportSearch parameters: - name: parentId in: path description: The custom object's resource identification number. 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 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: CustomObjectExportSearchResponse description: The response body contains information about the custom object 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-customObjects-{parentId}-exports-get x-filename-id: api-bulk-2.0-customobjects-parentid-exports-get post: tags: - Bulk/2.0/customObjects summary: Create an export definition for a custom object description: Creates a new export definition for the specified custom object. See the tutorial for details on how to export data. operationId: PostCustomObjectExportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: CustomObjectExportIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-exports-post x-filename-id: api-bulk-2.0-customobjects-parentid-exports-post requestBody: content: application/json: schema: title: CustomObjectExportIndividual description: The request body defines the details of the custom object 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: CustomObjectExportIndividual description: The request body defines the details of the custom object 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 custom object export definition. required: true /api/bulk/2.0/customObjects/{parentId}/fields: get: tags: - Bulk/2.0/customObjects summary: Retrieve a list of the fields for a custom object description: Retrieves a custom object field definition for the custom object and field ids provided. operationId: GetCustomObjectFieldSearch parameters: - name: parentId in: path description: The custom object's resource identification number. 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 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: CustomObjectFieldSearchResponse description: The response body contains information about the custom object 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/CustomObjectField' 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: 'This captures the total number of records that satisfy the request. This is not the count returned in the current response, but total count on the server side. Example: ?totalResults=true.' 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-customObjects-{parentId}-fields-get x-filename-id: api-bulk-2.0-customobjects-parentid-fields-get /api/bulk/2.0/customObjects/{parentId}/imports: get: tags: - Bulk/2.0/customObjects summary: Retrieve a list of import definitions for a custom object description: Retrieves the list of import definitions for the custom object with the specified id. operationId: GetCustomObjectImportSearch parameters: - name: parentId in: path description: The custom object's resource identification number. 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 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: CustomObjectImportSearchResponse description: The response body contains information about the custom object 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 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-customObjects-{parentId}-imports-get x-filename-id: api-bulk-2.0-customobjects-parentid-imports-get post: tags: - Bulk/2.0/customObjects summary: Create an import definition for a custom object description: Creates a new import definition for the specified custom object. See the tutorial for details on how to import data. operationId: PostCustomObjectImportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: CustomObjectImportIndividualResponse description: The response body includes information about the custom object 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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-customObjects-{parentId}-imports-post x-filename-id: api-bulk-2.0-customobjects-parentid-imports-post requestBody: content: application/json: schema: title: CustomObjectImportIndividual description: The request body defines the details of the custom object 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 id: title: id description: The import definition???s resource identification number. type: integer 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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 parentId: title: parentId description: The parent object's resource identification number. type: integer 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: CustomObjectImportIndividual description: The request body defines the details of the custom object 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 id: title: id description: The import definition???s resource identification number. type: integer 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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 parentId: title: parentId description: The parent object's resource identification number. type: integer 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 custom object import definition. required: true /api/bulk/2.0/customObjects/{parentId}/syncActions: get: tags: - Bulk/2.0/customObjects summary: Retrieve a list of sync action definitions for a custom object description: Retrieves a list of sync action definitions for the specified custom object. operationId: GetCustomObjectSyncActionOperationSearch parameters: - name: parentId in: path description: The custom object's resource identification number. 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 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: CustomObjectSyncActionOperationSearchResponse description: The response body contains information about the custom object 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-customObjects-{parentId}-syncActions-get x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-get post: tags: - Bulk/2.0/customObjects summary: Create a custom object sync action definition description: Creates a new custom object sync action definition. operationId: PostCustomObjectSyncActionOperationIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: CustomObjectSyncActionOperationIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-syncActions-post x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-post requestBody: content: application/json: schema: title: CustomObjectSyncActionOperationIndividual description: The request body defines details of the custom object 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: CustomObjectSyncActionOperationIndividual description: The request body defines details of the custom object 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 contains details of the custom object sync action definition. required: true /api/bulk/2.0/customObjects/{parentId}/exports/{id}: get: tags: - Bulk/2.0/customObjects summary: Retrieve the specified export definition for a custom object description: Retrieves the specified export definition for the specified custom object. operationId: GetCustomObjectExportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object export's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectExportIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-exports-{id}-get x-filename-id: api-bulk-2.0-customobjects-parentid-exports-id-get put: tags: - Bulk/2.0/customObjects summary: Update an export definition for a custom object description: Updates the specified export definition for the specified custom object. operationId: PutCustomObjectExportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object export's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectExportIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-exports-{id}-put x-filename-id: api-bulk-2.0-customobjects-parentid-exports-id-put requestBody: content: application/json: schema: title: CustomObjectExportIndividual description: The request body defines the details of the custom object 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: CustomObjectExportIndividual description: The request body defines the details of the custom object 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 custom object export definition. required: true delete: tags: - Bulk/2.0/customObjects summary: Delete a custom object export definition description: Deletes the specified custom object export definition. operationId: DeleteCustomObjectExportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object export'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-customObjects-{parentId}-exports-{id}-delete x-filename-id: api-bulk-2.0-customobjects-parentid-exports-id-delete /api/bulk/2.0/customObjects/{parentId}/exports/{id}/data: get: tags: - Bulk/2.0/customObjects summary: Retrieve the synced data for a custom object export definition description: Retrieves the synced data for a custom object export definition. operationId: GetCustomObjectExportDataQuery parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object export's resource identification number. 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: CustomObjectExportDataQueryResponse description: The response body includes information about the synced data for the custom object export definition. 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: A list of the custom object's export data. 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-customObjects-{parentId}-exports-{id}-data-get x-filename-id: api-bulk-2.0-customobjects-parentid-exports-id-data-get delete: tags: - Bulk/2.0/customObjects summary: Delete the synced data for a custom object export definition description: Deletes the synced data for the specified custom object export definition. operationId: DeleteCustomObjectExportDataQuery parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object export'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-customObjects-{parentId}-exports-{id}-data-delete x-filename-id: api-bulk-2.0-customobjects-parentid-exports-id-data-delete /api/bulk/2.0/customObjects/{parentId}/fields/{id}: get: tags: - Bulk/2.0/customObjects summary: Retrieve a custom object field definition description: Retrieves a custom object field definition for the custom object and field ids provided. operationId: GetCustomObjectFieldIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The custom object's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectFieldIndividualResponse description: The response body contains information about the custom object 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 custom object 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-customObjects-{parentId}-fields-{id}-get x-filename-id: api-bulk-2.0-customobjects-parentid-fields-id-get /api/bulk/2.0/customObjects/{parentId}/imports/{id}: get: tags: - Bulk/2.0/customObjects summary: Retrieve an import definition for a custom object description: Retrieves the specified import definition for the specified custom object. operationId: GetCustomObjectImportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The import definition???s resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectImportIndividualResponse description: The response body includes information about the custom object 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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-customObjects-{parentId}-imports-{id}-get x-filename-id: api-bulk-2.0-customobjects-parentid-imports-id-get put: tags: - Bulk/2.0/customObjects summary: Update an import definition for a custom object description: Updates the specified import definition for the specified custom object. operationId: PutCustomObjectImportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The import definition???s resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectImportIndividualResponse description: The response body includes information about the custom object 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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-customObjects-{parentId}-imports-{id}-put x-filename-id: api-bulk-2.0-customobjects-parentid-imports-id-put requestBody: content: application/json: schema: title: CustomObjectImportIndividual description: The request body defines the details of the custom object 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 id: title: id description: The import definition???s resource identification number. type: integer 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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 parentId: title: parentId description: The parent object's resource identification number. type: integer 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: CustomObjectImportIndividual description: The request body defines the details of the custom object 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 id: title: id description: The import definition???s resource identification number. type: integer 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 mapDataCards: title: mapDataCards description: Whether or not data cards will be mapped on import. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsCaseSensitiveMatch: title: mapDataCardsCaseSensitiveMatch description: Perform a case sensitive search when mapping custom object records or events to a contact or account. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: boolean mapDataCardsEntityField: title: mapDataCardsEntityField description: This field specifies which Eloqua entity field will be used for mapping. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsEntityType: title: mapDataCardsEntityType description: This field specifies the entity of the custom data object or event import. Allowed values are "Contact" or "Company". For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string mapDataCardsSourceField: title: mapDataCardsSourceField description: This field specifies the source document field that will be used for matching. For more information about this parameter, see the Oracle Eloqua Developer Help Center. type: string 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 parentId: title: parentId description: The parent object's resource identification number. type: integer 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 custom object import definition. required: true delete: tags: - Bulk/2.0/customObjects summary: Delete a custom object import definition description: Deletes the specified custom object import definition. operationId: DeleteCustomObjectImportIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The import 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-customObjects-{parentId}-imports-{id}-delete x-filename-id: api-bulk-2.0-customobjects-parentid-imports-id-delete /api/bulk/2.0/customObjects/{parentId}/imports/{id}/data: post: tags: - Bulk/2.0/customObjects summary: Upload data for a custom object import definition description: Uploads data for the specified custom object import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8. operationId: PostCustomObjectImportData parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The import definition???s resource identification number. required: true schema: type: integer responses: '201': description: Success. content: application/json: schema: title: CustomObjectImportDataResponse description: Sync response when POSTing custom object 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-customObjects-{parentId}-imports-{id}-data-post x-filename-id: api-bulk-2.0-customobjects-parentid-imports-id-data-post requestBody: content: application/json: schema: title: CustomObjectImportData type: array items: title: CustomObjectImportDataItem type: object items: type: string text/csv: schema: title: CustomObjectImportData type: array items: title: CustomObjectImportDataItem type: object items: type: string description: The request body contains data to be uploaded to the custom object import definition. required: true delete: tags: - Bulk/2.0/customObjects summary: Delete synced data for a custom object import definition description: Deletes the synced data for the specified custom object import definition. operationId: DeleteCustomObjectImportData parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The import 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-customObjects-{parentId}-imports-{id}-data-delete x-filename-id: api-bulk-2.0-customobjects-parentid-imports-id-data-delete /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}: get: tags: - Bulk/2.0/customObjects summary: Retrieve a custom object sync action definition for a custom object description: Retrieve a custom object sync action definition for the specified custom object and sync action definition. operationId: GetCustomObjectSyncActionOperationIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectSyncActionOperationIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-syncActions-{id}-get x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-id-get put: tags: - Bulk/2.0/customObjects summary: Update a custom object sync action definition description: Updates the specified custom object sync action definition. For PUT requests, the parameters below are required for validation, even if they are not changing. operationId: PutCustomObjectSyncActionOperationIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - name: id in: path description: The sync action definition's resource identification number. required: true schema: type: integer responses: '200': description: OK. content: application/json: schema: title: CustomObjectSyncActionOperationIndividualResponse description: The response body includes information about the custom object 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-customObjects-{parentId}-syncActions-{id}-put x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-id-put requestBody: content: application/json: schema: title: CustomObjectSyncActionOperationIndividual description: The request body defines details of the custom object 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: CustomObjectSyncActionOperationIndividual description: The request body defines details of the custom object 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 contains details of the custom object sync action definition. required: true delete: tags: - Bulk/2.0/customObjects summary: Delete a custom object sync action definition description: Deletes the specified custom object sync action definition. operationId: DeleteCustomObjectSyncActionOperationIndividual parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - 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-customObjects-{parentId}-syncActions-{id}-delete x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-id-delete /api/bulk/2.0/customObjects/{parentId}/syncActions/{id}/data: post: tags: - Bulk/2.0/customObjects summary: Upload custom object sync action data description: Uploads custom object sync data for a specified custom object and sync action definition. operationId: PostCustomObjectSyncActionOperationData parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - 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: CustomObjectSyncActionOperationDataResponse description: Sync response when POSTing custom object 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-customObjects-{parentId}-syncActions-{id}-data-post x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-id-data-post requestBody: content: application/json: schema: title: CustomObjectSyncActionOperationData type: array items: title: CustomObjectSyncActionOperationDataItem type: object items: type: string text/csv: schema: title: CustomObjectSyncActionOperationData type: array items: title: CustomObjectSyncActionOperationDataItem type: object items: type: string description: The request body contains details of the custom object sync action definition. required: true delete: tags: - Bulk/2.0/customObjects summary: Delete sync data for a custom object sync action definition description: Deletes sync data for a specified custom object sync action. operationId: DeleteCustomObjectSyncActionOperationData parameters: - name: parentId in: path description: The custom object's resource identification number. required: true schema: type: integer - 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-customObjects-{parentId}-syncActions-{id}-data-delete x-filename-id: api-bulk-2.0-customobjects-parentid-syncactions-id-data-delete /api/bulk/2.0/customObjects: get: tags: - Bulk/2.0/customObjects summary: Retrieve a list of custom objects description: Retrieves all custom objects that match the criteria specified in the URL parameters. operationId: GetCustomObjectSearch 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: CustomObjectSearchResponse description: The response body contains information about the custom object 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/CustomObject' 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-customObjects-get x-filename-id: api-bulk-2.0-customobjects-get components: schemas: CustomObject: title: CustomObject description: 'The definition of a custom object. Custom Objects are used to store data that may be related to a Contact or Company''s record. Some examples of data you might store in a custom object include: Product Purchase history, Registrations, Warranty Expiry. Custom objects can be synchronized with your CRM system on a scheduled basis.' 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 displayNameFieldUri: title: displayNameFieldUri description: The relative uri used to reference the custom object field that represents the display field, for this custom object. type: string emailAddressFieldUri: title: emailAddressFieldUri description: The relative uri used to reference the custom object field that represents an email address, for this custom object. type: string name: title: name description: The name of the custom object definition. type: string uniqueFieldUri: title: uniqueFieldUri description: The relative uri used to reference the custom object field that has a uniqueness constraint on it, for this custom object. 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 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 CustomObjectField: title: CustomObjectField description: The definition of a field on the referenced custom object. 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 custom object 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 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 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 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