openapi: 3.2.0
info:
  title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Contacts 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/Contacts
  description: 'A contact is a data entity that contains the explicit data around an individual person in the database.


    <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=Contacts''>Learn more about contacts</a>.'
paths:
  /api/rest/2.0/data/contact/{id}:
    get:
      operationId: ReadIndividualGETRest20
      parameters:
      - name: id
        in: path
        description: Id of the contact
        required: true
        schema:
          type: string
      - 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: viewId
        in: query
        description: 'The user''s default contact view identifier. '
        required: false
        schema:
          type: string
      summary: Retrieves a contact
      description: Retrieves the contact specified by the <code>id</code> parameter.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactRest20'
        '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/Contacts
      x-internal-id: api-rest-2.0-data-contact-{id}-get
      x-filename-id: api-rest-2.0-data-contact-id-get
    put:
      operationId: UpdateIndividualPUTRest20
      parameters:
      - name: id
        in: path
        description: Id of the contact
        required: true
        schema:
          type: string
      summary: Update a contact
      description: The request body defines the details of the contact to be updated.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactRest20'
        '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/Contacts
      x-internal-id: api-rest-2.0-data-contact-{id}-put
      x-filename-id: api-rest-2.0-data-contact-id-put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactRest20'
        description: The request body defines the details of the contact to be updated.
        required: true
  /api/rest/2.0/data/contact/{id}/membership:
    get:
      operationId: ListGroupMembershipGETRest20
      parameters:
      - name: id
        in: path
        description: Id of the contact to retrieve.
        required: true
        schema:
          type: integer
      summary: Retrieve contact list membership information for a contact
      description: Retrieves a list of contact lists that a contact is a member of.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactListRest20'
        '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/Contacts
      x-internal-id: api-rest-2.0-data-contact-{id}-membership-get
      x-filename-id: api-rest-2.0-data-contact-id-membership-get
  /api/rest/2.0/data/contacts:
    post:
      operationId: SearchContactsSEARCHRest20
      parameters:
      - name: X-HTTP-Method-Override
        in: header
        description: The request header <code>X-HTTP-Method-Override</code> must be set with value <code>SEARCH</code>.
        required: true
        schema:
          type: string
          format: string
          default: SEARCH
      summary: Retrieve contact information
      description: Retrieves contact information for up to 200 contacts, searched by contact id. Use the <code>depth</code> parameter when making the request to specify the contact information returned in the response.
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactRest20'
        '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/Contacts
      x-internal-id: api-rest-2.0-data-contacts-post
      x-filename-id: api-rest-2.0-data-contacts-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySearchByIdsRest20'
        description: The request body defines the details of the request.
        required: true
components:
  schemas:
    ContactListRest20:
      title: ContactList
      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 list.
        currentStatus:
          type: string
          description: The contact list's current status. This is a read-only property.
        name:
          type: string
          description: The contact list's name.
        description:
          type: string
          description: The description of the contact list.
        permissions:
          type: array
          description: The permissions for the contact list 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 list.
        sourceTemplateId:
          type: string
          description: Id of the template used to create the contact list.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the contact list.
        createdByName:
          type: string
          description: The name of the user who created the contact list.
        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 list.
        updatedByName:
          type: string
          description: The name of the user who last updated the contact list.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the contact list was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date the contact list is scheduled.
        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>.'
        scope:
          type: string
          description: 'The contact list''s scope: either local or global.'
        count:
          type: string
          readOnly: true
          description: The number of contacts in the contact list. This is a read-only property.
        membershipAdditions:
          type: array
          description: The number of contact membership additions in the contact list.
          items:
            type: string
        membershipDeletions:
          type: array
          description: The number of contact membership deletions in the contact list.
          items:
            type: string
        dataLookupId:
          type: string
          description: The contact list's data lookup Id. This is a read-only property.
    EntitySearchByIdsRest20:
      title: EntitySearchByIds
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        depth:
          type: string
          readOnly: true
          description: Level of detail returned by the request. The default will be <code>minimal</code>. <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Learn more about the depth parameter</a>.
        ids:
          type: array
          description: The ids to retrieve. Maximum of 200 ids per request. If the array contains duplicate ids, or exceeds the 200 limit, a <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>400 Bad Request</a> will be returned.
          items:
            type: integer
    FieldValueRest20:
      title: FieldValue
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
        value:
          type: string
          description: The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
        id:
          type: string
          readOnly: true
          description: The id of the field to be set to the corresponding value.
        name:
          type: string
          description: Name of the field value.
    ContactRest20:
      title: Contact
      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. This is a read-only property.
        currentStatus:
          type: string
          description: The contact's current status.
        name:
          type: string
          description: The name of the contact.
        description:
          type: string
          description: The description of the contact.
        permissions:
          type: array
          description: The permissions for the contact 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.
        sourceTemplateId:
          type: string
          description: Id of the template used to create the asset.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the contact.
        createdByName:
          type: string
          description: The name of the user who created the contact.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the contact was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the contact.
        updatedByName:
          type: string
          description: The name of the user who last updated the contact.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the contact was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: The date the contact is scheduled.
        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>.'
        firstName:
          type: string
          description: The contact's first name.
        lastName:
          type: string
          description: The contact's last name.
        emailAddress:
          type: string
          description: The contact's email address.
        emailFormatPreference:
          type: string
          description: The contact's email format preference.
        isSubscribed:
          type: string
          description: Whether or not the contact is subscribed.
        isSmsSubscribed:
          type: string
          description: Whether or not the contact is subscribed for SMS.
        isBounceback:
          type: string
          description: Whether or not the contact has any associated bouncebacks.
        accountName:
          type: string
          description: The account name in which the contact belongs.
        accountId:
          type: string
          description: The account id in which the contact belongs. This is a read-only property.
        title:
          type: string
          description: The contact's title.
        subscriptionDate:
          type: string
          description: The contact's subscription date.
        unsubscriptionDate:
          type: string
          description: The contact's unsubscription date.
        bouncebackDate:
          type: string
          description: The contact's bounceback date.
        fieldValues:
          type: array
          description: Array containing <code>type</code> and <code>id</code> values for all of the contactFields associated with a given contact.
          items:
            $ref: '#/components/schemas/FieldValueRest20'
        address1:
          type: string
          description: The contact's first address.
        address2:
          type: string
          description: The contact's second address.
        address3:
          type: string
          description: The contact's third address.
        city:
          type: string
          description: The contact's city.
        province:
          type: string
          description: The contact's province.
        postalCode:
          type: string
          description: The contact's postal code.
        country:
          type: string
          description: The contact's country.
        businessPhone:
          type: string
          description: The contact's business phone number.
        mobilePhone:
          type: string
          description: The contact's mobile phone number.
        fax:
          type: string
          description: The contact's fax number.
        salesPerson:
          type: string
          description: The contact's account representative.
        stepEntryTime:
          type: string
          description: The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a <code>stepid</code> is provided.
        nextEvaluationTime:
          type: string
          description: The time when the contact is scheduled to be processed. This is a read-only property.  This property can only be retrieved when a <code>stepid</code> is provided.
        createdSourceType:
          type: string
          description: Contact_Field_CreatedSourceType_Description
        updatedSourceType:
          type: string
          description: Contact_Field_UpdatedSourceType_Description