openapi: 3.2.0
info:
  title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Events 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: Application/2.0/Events
  description: 'The events API is used to manage events.


    <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=EventManagement''>Learn more about Event Management</a>.'
paths:
  /api/rest/2.0/assets/eventRegistration:
    post:
      operationId: CreateIndividualPOSTRest20
      summary: Create an event
      description: Creates an event that matches the criteria specified by the request body.
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegistrationRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Events
      x-internal-id: api-rest-2.0-assets-eventRegistration-post
      x-filename-id: api-rest-2.0-assets-eventregistration-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventRegistrationRest20'
        description: The request body defines the details of the event to be created.
        required: true
  /api/rest/2.0/assets/eventRegistration/{id}:
    get:
      operationId: ReadIndividualGETRest20
      parameters:
      - name: id
        in: path
        description: Id of the event.
        required: true
        schema:
          type: integer
      - name: depth
        in: query
        description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        required: false
        schema:
          type: string
      summary: Retrieve an event
      description: Retrieves the event specified by the <code>id</code> parameter.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegistrationRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Events
      x-internal-id: api-rest-2.0-assets-eventRegistration-{id}-get
      x-filename-id: api-rest-2.0-assets-eventregistration-id-get
    put:
      operationId: UpdateIndividualPUTRest20
      parameters:
      - name: id
        in: path
        description: Id of the event.
        required: true
        schema:
          type: integer
      summary: Update an event
      description: Updates the event specified by the <code>id</code> parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventRegistrationRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Events
      x-internal-id: api-rest-2.0-assets-eventRegistration-{id}-put
      x-filename-id: api-rest-2.0-assets-eventregistration-id-put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventRegistrationRest20'
        description: The request body defines the details of the event to be updated.
        required: true
    delete:
      operationId: DeleteIndividualDELETERest20
      parameters:
      - name: id
        in: path
        description: Id of the event.
        required: true
        schema:
          type: integer
      summary: Delete an event
      description: Deletes the event specified by the <code>id</code> parameter.
      responses:
        '200':
          description: OK.
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Events
      x-internal-id: api-rest-2.0-assets-eventRegistration-{id}-delete
      x-filename-id: api-rest-2.0-assets-eventregistration-id-delete
  /api/rest/2.0/assets/eventRegistrations:
    get:
      operationId: SearchGETRest20
      parameters:
      - name: depth
        in: query
        description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.'
        required: false
        schema:
          type: string
      - name: count
        in: query
        description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
        required: false
        schema:
          type: integer
      - name: search
        in: query
        description: Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
        required: false
        schema:
          type: string
      - name: orderBy
        in: query
        description: Specifies the field by which list results are ordered.
        required: false
        schema:
          type: string
      - name: lastUpdatedAt
        in: query
        description: Unix timestamp for the date and time the event was last updated.
        required: false
        schema:
          type: integer
      summary: Retrieve a list of events
      description: Retrieves all events that match the criteria specified by the request parameters.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResultEventRegistrationRest20'
        '400':
          description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '401':
          description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '403':
          description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '404':
          description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
        '500':
          description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
      tags:
      - Application/2.0/Events
      x-internal-id: api-rest-2.0-assets-eventRegistrations-get
      x-filename-id: api-rest-2.0-assets-eventregistrations-get
components:
  schemas:
    EventSessionFieldValueRest20:
      title: EventSessionFieldValue
      properties:
        type:
          type: string
          description: The asset's type in Eloqua.
        id:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        currentStatus:
          type: string
          description: This property is not used for event session field values.
        name:
          type: string
          description: This property is not used for event session field values.
        description:
          type: string
          description: This property is not used for event session field values.
        permissions:
          type: array
          description: This property is not used.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        sourceTemplateId:
          type: string
          description: This property is not used for event session field values.
        createdBy:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        createdByName:
          type: string
          description: This property is not used for event session field values.
        createdAt:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        updatedBy:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        updatedByName:
          type: string
          description: This property is not used for event session field values.
        updatedAt:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        depth:
          type: string
          readOnly: true
          description: This property is not used for event session field values.
        sessionId:
          type: string
          description: The SessionId of the session within an event for which field value is passed.
        sessionFieldId:
          type: string
          description: The SessionFieldId of the field. The session field must be created first before creating session field values.
        value:
          type: string
          description: The value for the event session field.
    QueryResultEventRegistrationRest20:
      title: QueryResultEventRegistration
      properties:
        type:
          type: string
          description: 'The asset''s type in Eloqua. '
        elements:
          type: array
          description: Array of event field elements.
          items:
            $ref: '#/components/schemas/EventRegistrationRest20'
        total:
          type: integer
          description: The total amount of results.
        pageSize:
          type: integer
          description: The page size.
        page:
          type: integer
          description: The specified page.
    CustomObjectFieldRest20:
      title: CustomObjectField
      properties:
        type:
          type: string
          description: 'The asset''s type in Eloqua. This is a read-only property. '
        id:
          type: string
          readOnly: true
          description: Id of the custom object field. This is a read-only property. Use negative ids in order to reference custom object fields for other properties (e.g. emailAddressFieldId or uniqueCodeFieldId). See example.
        currentStatus:
          type: string
          description: This property is not used for custom object fields.
        description:
          type: string
          description: This property is not used for custom object fields.
        permissions:
          type: array
          description: This property is not used.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        sourceTemplateId:
          type: string
          description: This property is not used for custom object fields.
        createdBy:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        createdByName:
          type: string
          description: This property is not used for custom object fields.
        createdAt:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        updatedBy:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        updatedByName:
          type: string
          description: This property is not used for custom object fields.
        updatedAt:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for custom object fields.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        name:
          type: string
          description: The name of the custom object field.
        displayType:
          type: string
          description: The custom object field's display type.
        dataType:
          type: string
          description: The custom object field's data type.
        defaultValue:
          type: string
          description: The custom object field's default value.
        internalName:
          type: string
          description: The custom object field's internal name. This is a read-only property.
        optionListId:
          type: string
          description: The option list id for a single select custom object field.
        checkedValue:
          type: string
          description: The checked value of a checkbox custom object field.
        uncheckedValue:
          type: string
          description: The unchecked value of a checkbox custom object field.
    EventRegistrationRest20:
      title: EventRegistration
      properties:
        type:
          type: string
          description: 'The asset''s type in Eloqua. This is a read-only property. '
        id:
          type: string
          readOnly: true
          description: Id of the event. This is a read-only property.
        currentStatus:
          type: string
          description: This property is not used for events.
        name:
          type: string
          description: The name of the event.
        description:
          type: string
          description: The description of the event.
        permissions:
          type: array
          description: This property is not used for events.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: The folder id of the folder which contains the event.
        sourceTemplateId:
          type: string
          description: This property is not used for events.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the event. This is a read-only property.
        createdByName:
          type: string
          description: The name of the user who created the event.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the event was created, expressed in Unix time. This is a read-only property.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the event. This is a read-only property.
        updatedByName:
          type: string
          description: The name of the user who last updated the event.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the event was last updated. This is a read-only property.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for events.
        depth:
          type: string
          readOnly: true
          description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        fields:
          type: array
          description: Array consisting of event field properties.
          items:
            $ref: '#/components/schemas/CustomObjectFieldRest20'
        sessions:
          type: array
          description: Array consisting of event sessions.
          items:
            $ref: '#/components/schemas/EventSessionRest20'
        sessionFields:
          type: array
          description: Array consisting of session fields within a session.
          items:
            $ref: '#/components/schemas/EventSessionFieldRest20'
        sessionFieldValues:
          type: array
          description: Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
          items:
            $ref: '#/components/schemas/EventSessionFieldValueRest20'
        emailAddressFieldId:
          type: string
          description: The field id that contains the Email Address. Use the desired custom object field's negative id as the value for this parameter.
        uniqueCodeFieldId:
          type: string
          description: The field id that contains the unique identifier. Use the desired custom object field's negative id as the value for this parameter. See example. To use an Eloqua Identifier, leave this parameter out of the request.
        eventGroupByFieldId:
          type: string
          description: The id of the field used to organize multiple sessions. Use the desired custom object field's negative id as the value for this parameter.
    FieldOutputFormatRest20:
      title: FieldOutputFormat
      properties:
        type:
          type: string
        currentStatus:
          type: string
        id:
          type: string
        format:
          type: string
        dataType:
          type: string
    EventSessionFieldRest20:
      title: EventSessionField
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        id:
          type: string
          readOnly: true
          description: Id of the event session field. This is a read-only property.
        currentStatus:
          type: string
          description: This property is not used for event session fields.
        name:
          type: string
          description: The name of the session field within an event.
        description:
          type: string
          description: This property is not used for event session fields.
        permissions:
          type: array
          description: This property is not used.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        sourceTemplateId:
          type: string
          description: This property is not used for event session fields.
        createdBy:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        createdByName:
          type: string
          description: This property is not used for event session fields.
        createdAt:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        updatedBy:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        updatedByName:
          type: string
          description: This property is not used for event session fields.
        updatedAt:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        depth:
          type: string
          readOnly: true
          description: This property is not used for event session fields.
        dataType:
          type: string
          description: The DataType of the session field.
        outputFormat:
          $ref: '#/components/schemas/FieldOutputFormatRest20'
          description: The output format for number, date / time, and numeric custom object fields. Only the display format???s id is required. See list of default display formats <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=DisplayFormats'>here</a>. If using custom display formats, these should be set in Eloqua.
    EventSessionRest20:
      title: EventSession
      properties:
        type:
          type: string
          description: The asset's type in Eloqua.
        id:
          type: string
          readOnly: true
          description: Id of the event session. This is a read-only property.
        currentStatus:
          type: string
          description: This property is not used for event sessions.
        name:
          type: string
          description: The name of the session.
        description:
          type: string
          description: This property is not used for event sessions.
        permissions:
          type: array
          description: This property is not used.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        sourceTemplateId:
          type: string
          description: This property is not used for event sessions.
        createdBy:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        createdByName:
          type: string
          description: This property is not used for event sessions.
        createdAt:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        updatedBy:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        updatedByName:
          type: string
          description: This property is not used for event sessions.
        updatedAt:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        depth:
          type: string
          readOnly: true
          description: This property is not used for event sessions.
        participantsLimit:
          type: integer
          description: The maximum number of participants per session.