Oracle ${sender Tag} API

openapi: 3.2.0
info:
  description: "Use the Email Delivery API to do the necessary set up to send high-volume and application-generated emails through the OCI Email Delivery service.\nFor more information, see [Overview of the Email Delivery Service](/iaas/Content/Email/Concepts/overview.htm).\n\n **Note:** Write actions (POST, UPDATE, DELETE) may take several minutes to propagate and be reflected by the API.\n If a subsequent read request fails to reflect your changes, wait a few minutes and try again.\n"
  license:
    name: Oracle Corporation
  title: Email Delivery ${sender Tag} ${sender Tag} API
  version: '20170907'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Email Delivery API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/2b8421e2e819f20bff147090f9d2586190bb5c6d3b8562ffb01d9f9fa99542be.yaml
    what: the harvested document for Email Delivery API
servers:
- url: https://127.0.0.1/20170907
tags:
- name: ${sender-tag}
paths:
  /senders:
    get:
      description: 'Gets a collection of approved sender email addresses and sender IDs.

        '
      operationId: ListSenders
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/compartmentIdQueryParam'
      - $ref: '#/components/parameters/lifecycleStateQueryParam'
      - $ref: '#/components/parameters/FilterByDomainQueryParam'
      - $ref: '#/components/parameters/senderEmailAddressQueryParam'
      - $ref: '#/components/parameters/FilterByIpPoolQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: 'A list of approved senders for the user.

            '
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain.

                For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-total-items:
              description: 'The total number of items returned from the request.

                '
              schema:
                type: integer
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/SenderSummary'
                type: array
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Get a list of approved sender summaries.
      tags:
      - ${sender-tag}
      x-example: 'GET /20170907/senders?compartmentId=ocid1.compartment.oc1...HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Sender'
    post:
      description: Creates a sender for a tenancy in a given compartment.
      operationId: CreateSender
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        '200':
          description: The newly created sender.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Creates a sender for a tenancy in a given compartment.
      tags:
      - ${sender-tag}
      x-example: "POST /20170907/senders HTTP/1.1\nHost: ctrl.email.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n  \"emailAddress\": \"test.user@mydomain.example.com\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSenderDetails'
        description: Create a sender.
        required: true
  /senders/{senderId}:
    delete:
      description: 'Deletes an approved sender for a tenancy in a given compartment for a

        provided `senderId`.

        '
      operationId: DeleteSender
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Deletes a sender for a tenancy in a given compartment.
      tags:
      - ${sender-tag}
      x-example: 'DELETE /20170907/senders/ocid1.emailsender.oc1.phx...HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/Sender'
    get:
      description: Gets an approved sender for a given `senderId`.
      operationId: GetSender
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      responses:
        '200':
          description: The approved sender for the specified OCID.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Gets an approved sender.
      tags:
      - ${sender-tag}
      x-example: 'GET /20170907/senders/ocid1.emailsender.oc1.phx...HTTP/1.1

        Host: ctrl.email.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: 'Replaces the set of tags for a sender with the tags provided. If either freeform

        or defined tags are omitted, the tags for that set remain the same. Each set must

        include the full set of tags for the sender, partial updates are not permitted.

        For more information about tagging, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

        '
      operationId: UpdateSender
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        '200':
          description: The newly updated sender.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '412':
          $ref: '#/components/responses/412'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Updates the tags for a given sender.
      tags:
      - ${sender-tag}
      x-example: "PUT /20170907/senders/ocid1.emailsender.oc1.phx...HTTP/1.1\nHost: ctrl.email.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"freeformTags\": {\"Department\": \"Finance\"}\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSenderDetails'
        description: update details for sender.
        required: true
  /senders/{senderId}/actions/addLock:
    post:
      description: Adds a lock to a resource.
      operationId: AddSenderLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      responses:
        '200':
          description: Lock is added.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Adds a lock to a resource.
      tags:
      - ${sender-tag}
      x-related-resource: '#/definitions/Sender'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddLockDetails'
        description: Details for adding a lock to a resource.
        required: true
  /senders/{senderId}/actions/changeCompartment:
    post:
      description: Moves a sender into a different compartment. When provided, If-Match is checked against ETag values of the resource.
      operationId: ChangeSenderCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        default:
          $ref: '#/components/responses/Error'
      summary: Moves a sender into a different compartment.
      tags:
      - ${sender-tag}
      x-example: "POST /20170907/senders/ocid1.emailsender.oc1.phx...HTTP/1.1\nHost: ctrl.email.us-phoenix-1.oci.oraclecloud.com\n <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n"
      x-related-resource: '#/definitions/Sender'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSenderCompartmentDetails'
        description: Details for moving a sender into a different compartment.
        required: true
  /senders/{senderId}/actions/removeLock:
    post:
      description: Remove a lock to a resource.
      operationId: RemoveSenderLock
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/senderIdPathParam'
      responses:
        '200':
          description: Lock is Removed.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/Error'
      summary: Remove a lock to a resource.
      tags:
      - ${sender-tag}
      x-related-resource: '#/definitions/Sender'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveLockDetails'
        description: Details for removing a lock from a resource.
        required: true
components:
  schemas:
    ResourceLock:
      description: 'Resource locks prevent certain APIs from being called for the resource.

        A full lock prevents both updating and deleting the resource. A delete lock

        prevents deleting the resource.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        message:
          description: 'A message added by the lock creator. The message typically gives an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

            '
          type: string
        timeCreated:
          description: Indicates when the lock was created, in the format defined by RFC 3339.
          format: date-time
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      - compartmentId
      type: object
    UpdateSenderDetails:
      description: 'The details allowed for updating a sender.

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        emailIpPoolId:
          description: The IpPool [OCID](/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
    Error:
      description: An error has occurred.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    AddLockDetails:
      description: 'Request payload to add lock to the resource.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        message:
          description: 'A message added by the lock creator. The message typically gives an

            indication of why the resource is locked.

            '
          type: string
        relatedResourceId:
          description: 'The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.

            '
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    CreateSenderDetails:
      description: 'The details needed for creating a sender.

        '
      properties:
        compartmentId:
          description: The OCID of the compartment that contains the sender.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        emailAddress:
          description: The email address of the sender.
          format: email
          maxLength: 254
          minLength: 6
          type: string
        emailIpPoolId:
          description: An optional field. The IpPool [OCID](/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
      required:
      - compartmentId
      - emailAddress
    ChangeSenderCompartmentDetails:
      description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

        into which the resource should be moved.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

            into which the sender should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    RemoveLockDetails:
      description: 'Request payload to remove the resource lock.

        '
      properties:
        compartmentId:
          description: The lock compartment ID.
          type: string
        type:
          description: Lock type.
          enum:
          - FULL
          - DELETE
          type: string
      required:
      - type
      type: object
    SenderSummary:
      description: The email addresses and `senderId` representing an approved sender.
      properties:
        compartmentId:
          description: The OCID for the compartment.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        emailAddress:
          description: The email address of the sender.
          maxLength: 254
          minLength: 6
          type: string
        emailIpPoolId:
          description: The IpPool [OCID](/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The unique ID of the sender.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: The current status of the approved sender.
          type: string
          x-obmcs-enumref: '#/definitions/Sender/lifecycleState'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Date time the approved sender was added, in "YYYY-MM-ddThh:mmZ"

            format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - emailAddress
    Sender:
      description: The full information representing an approved sender.
      properties:
        compartmentId:
          description: The OCID for the compartment.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported as valid value type.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.


              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        emailAddress:
          description: Email address of the sender.
          format: email
          maxLength: 254
          minLength: 6
          type: string
        emailDomainId:
          description: 'The email domain used to assert responsibility for emails sent from this sender.

            '
          maxLength: 255
          minLength: 1
          type: string
        emailIpPoolId:
          description: The IpPool [OCID](/iaas/Content/General/Concepts/identifiers.htm) used to submit an email by Email Delivery when sent from this sender.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The unique OCID of the sender.
          maxLength: 255
          minLength: 1
          type: string
        isSpf:
          default: false
          description: 'Value of the SPF field. For more information about SPF, please see

            [SPF Authentication](https://docs.us-phoenix-1.oraclecloud.com/Content/Email/Concepts/overview.htm#components).

            '
          type: boolean
        lifecycleState:
          description: The sender's current lifecycle state.
          enum:
          - CREATING
          - ACTIVE
          - NEEDS_ATTENTION
          - INACTIVE
          - FAILED
          - DELETING
          - DELETED
          - UPDATING
          type: string
          x-default-description: 'null'
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'The date and time the approved sender was added in "YYYY-MM-ddThh:mmZ"

            format with a Z offset, as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - emailAddress
  parameters:
    FilterByDomainQueryParam:
      description: A filter to only return resources that match the given domain exactly.
      in: query
      name: domain
      required: false
      x-default-description: 'null'
      schema:
        type: string
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous "List" call.

        For important details about how pagination works,

        see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 2000
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. The `TIMECREATED` value returns the list in in

        descending order by default. The `EMAILADDRESS` value returns the list in

        ascending order by default. Use the `SortOrderQueryParam` to change the

        direction of the returned list of items.

        '
      in: query
      name: sortBy
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - TIMECREATED
        - EMAILADDRESS
    compartmentIdQueryParam:
      description: The OCID for the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    FilterByIpPoolQueryParam:
      description: A filter to only return resources that match the given IpPool resource exactly.
      in: query
      name: emailIpPoolId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: 'Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match`

        parameter to the value of the etag from a previous get, create, or update response for that resource.  The resource

        will be updated or deleted only if the etag you provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. `1` is the minimum, `1000` is the maximum. For important details about

        how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        maximum: 1000
        minimum

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-sender-tag-api-openapi.yml