Oracle Eloqua Application/2.0/SMS API

openapi: 3.2.0
info:
  title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/SMS 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/SMS
  description: SMS API endpoints.
paths:
  /api/rest/2.0/assets/sms:
    post:
      operationId: CreateIndividualPOSTRest20
      summary: Create an SMS
      description: Creates an SMS that matches the criteria specified by the request body.
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsRest20'
        '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/SMS
      x-internal-id: api-rest-2.0-assets-sms-post
      x-filename-id: api-rest-2.0-assets-sms-post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsRest20'
        description: The request body defines the details of an sms to be created.
        required: true
    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: The date and time an sms was last updated.
        required: false
        schema:
          type: integer
      summary: Retrieve a list of SMS
      description: Retrieves all SMS that match the criteria specified by the request parameters.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResultSmsRest20'
        '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/SMS
      x-internal-id: api-rest-2.0-assets-sms-get
      x-filename-id: api-rest-2.0-assets-sms-get
  /api/rest/2.0/assets/sms/{id}:
    put:
      operationId: UpdateIndividualPUTRest20
      parameters:
      - name: id
        in: path
        description: Id of an sms.
        required: true
        schema:
          type: string
      summary: Update an SMS
      description: Updates the SMS specified by the <code>id</code>.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsRest20'
        '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/SMS
      x-internal-id: api-rest-2.0-assets-sms-{id}-put
      x-filename-id: api-rest-2.0-assets-sms-id-put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsRest20'
        description: The request body defines the details of an sms to be updated.
        required: true
    get:
      operationId: ReadIndividualGETRest20
      parameters:
      - name: id
        in: path
        description: Id of an sms.
        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>minimal</code> by default.'
        required: false
        schema:
          type: string
      summary: Retrieve an SMS
      description: Retrieves the SMS specified by the <code>id</code>.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsRest20'
        '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/SMS
      x-internal-id: api-rest-2.0-assets-sms-{id}-get
      x-filename-id: api-rest-2.0-assets-sms-id-get
    delete:
      operationId: DeleteIndividualDELETERest20
      parameters:
      - name: id
        in: path
        description: Id of an sms to be deleted.
        required: true
        schema:
          type: integer
      summary: Delete an SMS
      description: Deletes the SMS specified by the <code>id</code>.
      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/SMS
      x-internal-id: api-rest-2.0-assets-sms-{id}-delete
      x-filename-id: api-rest-2.0-assets-sms-id-delete
components:
  schemas:
    QueryResultSmsRest20:
      title: QueryResultSms
      properties:
        type:
          type: string
          description: The asset's type in Eloqua.
        elements:
          type: array
          description: Array of sms fields.
          items:
            $ref: '#/components/schemas/SmsRest20'
        total:
          type: integer
          description: The total amount of results.
        pageSize:
          type: integer
          description: The page size.
        page:
          type: integer
          description: The specified page.
    FieldConditionRest20:
      title: FieldCondition
      properties:
        type:
          type: string
        id:
          type: string
          readOnly: true
        currentStatus:
          type: string
        name:
          type: string
        description:
          type: string
        permissions:
          type: array
          items:
            type: string
        folderId:
          type: string
          readOnly: true
        sourceTemplateId:
          type: string
        createdBy:
          type: string
          readOnly: true
        createdByName:
          type: string
        createdAt:
          type: string
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        updatedByName:
          type: string
        updatedAt:
          type: string
          readOnly: true
        scheduledFor:
          type: string
          readOnly: true
        depth:
          type: string
          readOnly: true
        condition:
          $ref: '#/components/schemas/ConditionRest20'
        fieldId:
          type: string
    FieldMergeRest20:
      title: FieldMerge
      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 field merge. This is a read-only property.
        currentStatus:
          type: string
          description: The field merge's current status.
        name:
          type: string
          description: Name of the field merge.
        description:
          type: string
          description: The description of the field merge.
        permissions:
          type: array
          description: The permissions for the field merge granted to your current instance.
          items:
            type: string
        folderId:
          type: string
          readOnly: true
          description: Id of the associated folder.
        sourceTemplateId:
          type: string
          description: The id of the source template.
        createdBy:
          type: string
          readOnly: true
          description: The login id of the user who created the field merge.
        createdByName:
          type: string
          description: The name of the user who created the field merge.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the field merge was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the field merge.
        updatedByName:
          type: string
          description: The name of the user who last updated the field merge.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the field merge was last updated.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used for field merges.
        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>.'
        syntax:
          type: string
          description: The syntax of the field merge.
        defaultValue:
          type: string
          description: The default value of the field merge.
        contactFieldId:
          type: string
          description: Id of the associated contact field.
        accountFieldId:
          type: string
          description: Id of the associated account field.
        eventId:
          type: string
          description: Id of the associated event.
        eventFieldId:
          type: string
          description: Id of the associated event field.
        eventSessionFieldId:
          type: string
          description: Id of the associated event session field.
        customObjectId:
          type: string
          description: Id of the associated custom object.
        customObjectFieldId:
          type: string
          description: Id of the associated custom object field.
        mergeType:
          type: string
          description: 'Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>.'
        customObjectSort:
          type: string
          description: The associated custom object sort type.
        queryStringKey:
          type: string
          description: 'The key value if the field merge contains a query string. See the <a href=''https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/FieldMerges/Tasks/CreatingFieldMergeWithQueryString.htm''>Help Center</a> to learn more about field merges with query strings. This is a read-only property. '
        fieldConditions:
          type: array
          description: Array of field condition fields.
          items:
            $ref: '#/components/schemas/FieldConditionRest20'
        allowUrlsInValue:
          type: string
          description: Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
    SmsSenderCodeRest20:
      title: SmsSenderCode
      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 sms sender code. This is a read-only property.
        currentStatus:
          type: string
          description: The sms sender code current status. This is a read-only property.
        name:
          type: string
          description: Name of the sms sender code.
        description:
          type: string
          description: Description of the sms sender code.
        permissions:
          type: array
          description: The permissions for the sms sender code 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 sms sender code.
        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 sms sender code.
        createdByName:
          type: string
          description: The name of the user who created the sms sender code.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the sms sender code was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the sms sender code.
        updatedByName:
          type: string
          description: The name of the user who last updated the sms sender code.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used
        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>. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        senderCodeId:
          type: string
          description: Id of the associated sender code.
        countryCode:
          type: string
          description: Associated country code.
        senderCode:
          type: string
          description: Associated sender code.
    ConditionRest20:
      title: Condition
      properties:
        type:
          type: string
          description: The asset's type in Eloqua. This is a read-only property.
    KeywordResponseRest20:
      title: KeywordResponse
      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 keyword response. This is a read-only property.
        currentStatus:
          type: string
          description: The keyword response current status. This is a read-only property
        description:
          type: string
          description: Description of the keyword response.
        permissions:
          type: array
          description: The permissions for the keyword response 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 keyword response.
        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 keyword response.
        createdByName:
          type: string
          description: The name of the user who created the keyword response.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the keyword response was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the keyword response.
        updatedByName:
          type: string
          description: The name of the user who last updated the keyword response.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the keyword response was last updated. This is a read-only property.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used
        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>. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        keyword:
          type: string
          description: Keyword associated with keyword response.
        response:
          type: string
          description: Response associated with the keyword.
        templateId:
          type: string
          description: Id of the template associated with the keyword response.
        keywordType:
          type: string
          description: The type of the keyword.
    SmsRest20:
      title: Sms
      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 sms. This is a read-only property.
        currentStatus:
          type: string
          description: The sms's current status. This is a read-only property
        description:
          type: string
          description: Description of the sms
        permissions:
          type: array
          description: The permissions for the sms 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 sms
        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 sms
        createdByName:
          type: string
          description: The name of the user who created the sms.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the sms was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the sms.
        updatedByName:
          type: string
          description: The name of the user who last updated the sms.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the sms was last updated. This is a read-only property.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used
        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>. 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: Name of the sms
        content:
          type: string
          description: Sms Content
        archived:
          type: string
          description: Whether or not the sms is archived
        smsType:
          type: string
          description: Purpose of sms.
        initiationType:
          type: string
          description: Type of initiation
        templateId:
          type: string
          description: Id of the template associated with the sms
        senderCodes:
          type: array
          description: Sender codes associated with the sms
          items:
            $ref: '#/components/schemas/SmsSenderCodeRest20'
        fieldMerges:
          type: array
          description: Field Merges associated with the sms
          items:
            $ref: '#/components/schemas/FieldMergeRest20'
        hyperLinks:
          type: array
          description: Hyperlinks associated with the sms
          items:
            $ref: '#/components/schemas/SmsLinkRest20'
        keywordResponses:
          type: array
          description: Keyword responses associated with the sms
          items:
            $ref: '#/components/schemas/KeywordResponseRest20'
    SmsLinkRest20:
      title: SmsLink
      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 sms link. This is a read-only property.
        currentStatus:
          type: string
          description: The sms link current status. This is a read-only property.
        name:
          type: string
          description: Name of the sms link.
        description:
          type: string
          description: Description of the sms link.
        permissions:
          type: array
          description: The permissions for the sms link 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 sms link.
        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 sms link.
        createdByName:
          type: string
          description: The name of the user who created the sms link.
        createdAt:
          type: string
          readOnly: true
          description: The date and time the sms link was created, expressed in Unix time.
        updatedBy:
          type: string
          readOnly: true
          description: The login id of the user that last updated the sms link.
        updatedByName:
          type: string
          description: The name of the user who last updated the sms link.
        updatedAt:
          type: string
          readOnly: true
          description: Unix timestamp for the date and time the sms link was last updated. This is a read-only property.
        scheduledFor:
          type: string
          readOnly: true
          description: This property is not used
        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>. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
        href:
          type: string
          description: Url represented by sms link.
        hyperlinkType:
          type: string
          description: Type of hyperlink represented by sms link.