openapi: 3.2.0
info:
  title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Contact segments 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/Contact segments
  description: 'Contact segments are groups of contacts generated based on filter criteria and contact lists.


    <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=Segments''>Learn more about Segments</a>.'
paths:
  /api/rest/2.0/assets/contact/segment:
    post:
      operationId: CreateIndividualPOSTRest20
      summary: Create a contact segment
      description: Creates a contact segment that matches the criteria specified by the request body.
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSegmentRest20'
        '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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segment-post
      x-filename-id: api-rest-2.0-assets-contact-segment-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactSegmentRest20'
        description: The request body defines the details of the contact segment to be created.
        required: true
  /api/rest/2.0/assets/contact/segment/{id}/copy:
    post:
      operationId: CreateCopyPOSTRest20
      parameters:
      - name: id
        in: path
        description: Id of the segment to copy.
        required: true
        schema:
          type: integer
      summary: Create a copy of a contact segment
      description: Creates a copy of a contact segment that matches the criteria specified by the request body.
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSegmentRest20'
        '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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segment-{id}-copy-post
      x-filename-id: api-rest-2.0-assets-contact-segment-id-copy-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactSegmentRest20'
        description: The request body defines the details of the contact segment to be created from the source contact segment.
        required: true
  /api/rest/2.0/assets/contact/segment/{id}:
    get:
      operationId: ReadIndividualGETRest20
      parameters:
      - name: id
        in: path
        description: Id of the contact segment.
        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 a contact segment
      description: Retrieves the contact segment specified by the <code>id</code> parameter.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSegmentRest20'
        '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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segment-{id}-get
      x-filename-id: api-rest-2.0-assets-contact-segment-id-get
    put:
      operationId: UpdateIndividualPUTRest20
      parameters:
      - name: id
        in: path
        description: Id of the contact segment.
        required: true
        schema:
          type: integer
      summary: Update a contact segment
      description: Updates the contact segment specified by the <code>id</code> parameter.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactSegmentRest20'
        '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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segment-{id}-put
      x-filename-id: api-rest-2.0-assets-contact-segment-id-put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactSegmentRest20'
        description: The request body defines the details of the contact segment to be update.
        required: true
    delete:
      operationId: DeleteIndividualDELETERest20
      parameters:
      - name: id
        in: path
        description: Id of the contact segment.
        required: true
        schema:
          type: integer
      summary: Delete a contact segment
      description: Deletes the contact segment 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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segment-{id}-delete
      x-filename-id: api-rest-2.0-assets-contact-segment-id-delete
  /api/rest/2.0/assets/contact/segments:
    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 contact segment was last updated.
        required: false
        schema:
          type: integer
      summary: Retrieve a list of contact segments
      description: Retrieves all contact segments that match the criteria specified by the request parameters
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResultSegmentRest20'
        '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/Contact segments
      x-internal-id: api-rest-2.0-assets-contact-segments-get
      x-filename-id: api-rest-2.0-assets-contact-segments-get
components:
  schemas:
    QueryResultSegmentRest20:
      title: QueryResultSegment
      properties:
        type:
          type: string
          description: The asset's type in Eloqua.
        elements:
          type: array
          description: Array of contact segment fields.
          items:
            $ref: '#/components/schemas/ContactSegmentRest20'
        total:
          type: integer
          description: The total amount of results.
        pageSize:
          type: integer
          description: The page size.
        page:
          type: integer
          description: The specified page.
    SegmentElementRest20:
      title: SegmentElement
      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 contact segment element. This is a read-only property.
        currentStatus:
          type: string
          description: The contact segment element's current status. This is a read-only property.
        name:
          type: string
          description: This property is not used for contact segment elements.
        description:
          type: string
          description: This property is not used for contact segment elements.
        permissions:
          type: array
          description: The permissions for the contact segment element granted to your current instance. This is a read-only property.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: The folder id of the folder which contains the contact segment element.
        sourceTemplateId:
          type: string
          description: This property is not used for contact segment elements.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the contact segment element.
        createdByName:
          type: string
          description: The name of the user who created the contact segment element.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the contact segment element was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the contact segment element.
        updatedByName:
          type: string
          description: The name of the user who last updated the contact segment element.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the contact segment element was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for contact segment elements.
        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>.'
        isIncluded:
          type: string
          description: The total amount of contacts within the segment element.
        count:
          type: string
          description: The number of contacts in the contact segment element. This is a read-only property.
        lastCalculatedAt:
          type: string
          description: The date and time the contact segment element was last calculated. This is a read-only property.
    ContactSegmentRest20:
      title: ContactSegment
      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 contact segment. This is a read-only property.
        currentStatus:
          type: string
          description: This property is not used for contact segments.
        name:
          type: string
          description: The contact segment's name.
        description:
          type: string
          description: This property is not used for contact segments.
        permissions:
          type: array
          description: The permissions for the contact segment granted to your current instance. This is a read-only property.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: The folder id of the folder which contains the contact segment.
        sourceTemplateId:
          type: string
          description: This property is not used for contact segments.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the contact segment.
        createdByName:
          type: string
          description: The name of the user who created the contact segment.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the contact segment was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the contact segment.
        updatedByName:
          type: string
          description: The name of the user who last updated the contact segment.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the contact segment was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for contact segments.
        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>.'
        elements:
          type: array
          description: Array of contact segment elements.
          items:
            $ref: '#/components/schemas/SegmentElementRest20'
        count:
          type: string
          description: The number of contacts in the contact segment. This is a read-only property.
        lastCalculatedAt:
          type: string
          description: The date and time of the most recent calculation. This is a read-only property.
        isStale:
          type: string
          description: Whether or not the contact segment has been refreshed in the last 24 hours by the user performing the request.
        dependencyName:
          type: string
          description: Segment_Field_DependencyName_Description