Incentivio Admin API

The operator-facing REST API behind Incentivio's brand administration console (admin.incentivio.com). A Spring Boot service that publishes a live, unauthenticated springdoc OpenAPI 3.1.0 definition at /v3/api-docs covering 327 paths and 421 operations across client and merchant configuration, store and location management, menu import and menu intelligence, items and sub-items, campaigns and offer distribution, guest journeys and personas, customer segments and tags, loyalty administration, gift card issuance and ACH funding, payments, refunds and fund transfers, Spreedly payment gateway connectors, role and module permissions, and a large reporting surface (sales, loyalty, offers, gift card balance, deliveries by location, SMS, guest journey, recommendation and customer reports) with CSV export. Tenancy is carried by an Inc-Client-Id header and clientid path parameters.

OpenAPI Specification

incentivio-admin-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: OpenAPI definition
  version: v0
servers:
- url: https://adminapi.incentivio.com/incentivio-admin-api
  description: Generated server url
paths:
  /toastsettings:
    put:
      tags:
      - spreedly-connector-controller
      operationId: setToastSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToastSettings'
        required: true
      responses:
        '200':
          description: OK
  /ml/portal/client/rules:
    put:
      tags:
      - ml-controller
      operationId: deleteRecommendationRule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeleteRuleResponse'
    post:
      tags:
      - ml-controller
      operationId: createRecommendationRules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateRuleResponse'
  /ml/portal/client/location/{clientid}:
    put:
      tags:
      - ml-controller
      operationId: updateLocations
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateLocationResponse'
  /ml/portal/client/item/category/change:
    put:
      tags:
      - ml-controller
      operationId: changeItemCategory
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemCategoryChaingingRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CategoryChangedItemResponse'
  /ml/portal/client/configuration:
    put:
      tags:
      - ml-controller
      operationId: updateConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigurationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdatedConfigurationResponse'
  /incentivio-wallet/clients/{clientid}/walletconfig:
    get:
      tags:
      - wallet-controller
      operationId: getWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WalletConfigDTO'
    put:
      tags:
      - wallet-controller
      operationId: setWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutWalletConfigRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/WalletConfigDTO'
    delete:
      tags:
      - wallet-controller
      operationId: deleteWalletConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-user-domain/customer-tags/{id}:
    get:
      tags:
      - customer-tag-and-rule-controller
      operationId: findCustomerTagById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/TagAndRuleDTO'
    put:
      tags:
      - customer-tag-and-rule-controller
      operationId: updateCustomerTag
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerTagRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - customer-tag-and-rule-controller
      operationId: deleteCustomerTag
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/subitems:
    put:
      tags:
      - sub-item-controller
      operationId: addOrUpdatePackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubItemRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateSubItemResponseDTO'
  /incentivio-ordering-service/packages:
    get:
      tags:
      - package-controller
      operationId: listPackagesByClientId
      parameters:
      - name: groupId
        in: query
        required: false
        schema:
          type: string
      - name: catalogId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListPackageResponseDTO'
    put:
      tags:
      - package-controller
      operationId: addOrUpdatePackage_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePackageRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreatePackageResponseDTO'
  /incentivio-ordering-service/orders/{orderid}/auditevents/{eventid}:
    put:
      tags:
      - order-controller
      operationId: updateAuditEvent
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      - name: eventid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAuditEventRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/merchants/{merchantid}:
    get:
      tags:
      - merchant-controller
      operationId: getLocationById
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MerchantResponseDTO'
    put:
      tags:
      - merchant-controller
      operationId: updateMerchant
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UpdateMerchantResponseDTO'
    delete:
      tags:
      - merchant-controller
      operationId: deleteMerchant
      parameters:
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/locations/{locationid}:
    get:
      tags:
      - location-controller
      operationId: getLocationById_1
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      - name: includeRelatedStores
        in: query
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/LocationResponseDTO'
    put:
      tags:
      - location-controller
      operationId: updateLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - location-controller
      operationId: deleteLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
    patch:
      tags:
      - location-controller
      operationId: patchLocation
      parameters:
      - name: locationid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchLocationRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/items:
    put:
      tags:
      - item-controller
      operationId: addOrUpdateItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateItemRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateItemResponseDTO'
    patch:
      tags:
      - item-controller
      operationId: patchItems
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/groups:
    get:
      tags:
      - group-controller
      operationId: listGroupsByCatalogId
      parameters:
      - name: catalogId
        in: query
        required: false
        schema:
          type: string
      - name: title
        in: query
        required: false
        schema:
          type: string
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 300
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: incentivioIds
        in: query
        required: false
        schema:
          type: string
      - name: externalIds
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Status'
      - name: type
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/GroupType'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/Direction'
          default: ASC
      - name: sortBy
        in: query
        required: false
        schema:
          type: string
          default: title
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListGroupResponseWithPagingForAdminDTO'
    put:
      tags:
      - group-controller
      operationId: addOrUpdateGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateGroupResponseDTO'
    patch:
      tags:
      - group-controller
      operationId: patchGroups
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/clients/{clientid}/presetorder/{orderid}:
    get:
      tags:
      - preset-order-controller
      operationId: getPresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
    put:
      tags:
      - preset-order-controller
      operationId: updatePresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePresetOrderConfigRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/GetPresetOrderConfigResponseDTO'
    delete:
      tags:
      - preset-order-controller
      operationId: deletePresetOrderConfig
      parameters:
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: orderid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-ordering-service/catalogs:
    put:
      tags:
      - order-controller
      operationId: addOrUpdateCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCatalogRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CreateCatalogResponseDTO'
    patch:
      tags:
      - order-controller
      operationId: patchCatalogs
      parameters:
      - name: storeId
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-menu-service/bulkimageuploads/{id}:
    get:
      tags:
      - bulk-image-upload-controller
      operationId: read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkImageUploadReadResponse'
    put:
      tags:
      - bulk-image-upload-controller
      operationId: update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 24
          minLength: 24
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImageUploadUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-giftcard-ach-service/achlocations:
    get:
      tags:
      - gift-card-ach-controller
      operationId: retrieveACHLocationsForAdmin
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ACHLocationDTO'
    put:
      tags:
      - gift-card-ach-controller
      operationId: updateLocation_1
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
    post:
      tags:
      - gift-card-ach-controller
      operationId: retrieveLocationsByACHLocationIDs
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/RetrieveAchLocationListResponse'
  /incentivio-giftcard-ach-service/achlocations/{locationId}/fundingaccount:
    put:
      tags:
      - gift-card-ach-controller
      operationId: updateFundingAccount
      parameters:
      - name: merchantId
        in: header
        required: true
        schema:
          type: string
          maxLength: 36
          minLength: 1
      - name: locationId
        in: path
        required: true
        schema:
          type: string
          maxLength: 49
          minLength: 36
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFundingAccountRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /incentivio-client-domain/templates/{templateId}:
    get:
      tags:
      - client-email-template-controller
      operationId: getClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
    put:
      tags:
      - client-email-template-controller
      operationId: updateClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientTemplateRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientTemplate'
    delete:
      tags:
      - client-email-template-controller
      operationId: deleteClientTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
  /incentivio-client-domain/clients/{clientid}/updaterole:
    put:
      tags:
      - role-module-permission-controller
      operationId: updateRole
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}:
    put:
      tags:
      - client-merchant-controller
      operationId: updateMerchant_1
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMerchantRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - client-merchant-controller
      operationId: deleteMerchant_1
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/merchants/{merchantid}/stores/{storeid}:
    put:
      tags:
      - store-controller
      operationId: updateStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStoreRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - store-controller
      operationId: deleteStore
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Merchant-Id
        in: header
        required: true
        schema:
          type: string
      - name: merchantid
        in: path
        required: true
        schema:
          type: string
      - name: Inc-Location-Id
        in: header
        required: true
        schema:
          type: string
      - name: storeid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/{clientid}/app-home-config/preview:
    put:
      tags:
      - app-home-config-controller
      operationId: updatePreview
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/schedules/{scheduleId}:
    put:
      tags:
      - app-home-config-controller
      operationId: updateSchedule
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundScheduleRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
    delete:
      tags:
      - app-home-config-controller
      operationId: deleteSchedule
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: scheduleId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/app-home-config/background/default:
    put:
      tags:
      - app-home-config-controller
      operationId: stageDefaultBackground
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultBackgroundRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
    delete:
      tags:
      - app-home-config-controller
      operationId: removeDefaultBackground
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AppHomeConfigDTO'
  /incentivio-client-domain/clients/{clientid}/admins/{adminid}:
    get:
      tags:
      - client-admin-controller
      operationId: findAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/FindAdminUserResponseDTO'
    put:
      tags:
      - client-admin-controller
      operationId: updateAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveAdminUserRequestDto'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - client-admin-controller
      operationId: deleteAdminUser
      parameters:
      - name: Inc-Client-Id
        in: header
        required: true
        schema:
          type: string
      - name: clientid
        in: path
        required: true
        schema:
          type: string
      - name: adminid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-client-domain/clients/email-config:
    get:
      tags:
      - client-configuration-controller
      operationId: getEmailConfig
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailSettingBasicInfoResponseDTO'
    put:
      tags:
      - client-configuration-controller
      operationId: updateEmailConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailSettingsCreateRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailSettingBasicInfoResponseDTO'
  /incentivio-auto-tagger-service/segments/{segmentId}:
    get:
      tags:
      - segment-controller
      operationId: findSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SegmentResponseDTO'
    put:
      tags:
      - segment-controller
      operationId: updateSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SegmentRequestDTO'
        required: true
      responses:
        '200':
          description: OK
    delete:
      tags:
      - segment-controller
      operationId: deleteSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /incentivio-auto-tagger-service/segments/{segmentId}/deactivate:
    put:
      tags:
      - segment-controller
      operationId: deactivateSegment
      parameters:
      - name: segmentId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /clients/{clientid}/webappconfig:
    get:
      tags:
      - web-app-config-controller
      operationId: getWebAppConfig
      parameters:
      - name: clientid
        in: path
        required: true
      

# --- truncated at 32 KB (534 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/openapi/incentivio-admin-api-openapi.yml