Incentivio

Incentivio Message Controller API

The message-controller API from Incentivio — 5 operation(s) for message-controller.

GitHub OpenAPI

Operations 5

POST /getactivitybasedmessages #
POST /changedistributedmessagestatus #
GET /messages/{messageid} #
GET /distributedmessages/{distributedmessageid} #
GET /appmessages #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/authentication/incentivio-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/openapi/incentivio-message-controller-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/conventions/incentivio-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/errors/incentivio-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/data-model/incentivio-data-model.yml
🔗
WellKnown
https://raw.githubusercontent.com/api-evangelist/incentivio/refs/heads/main/well-known/incentivio-well-known.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/incentivio-message-controller-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

incentivio-message-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Message Controller API
  version: v0
servers:
- url: https://mobile.incentivio.com/incentivio-mobile-api
  description: Generated server url
tags:
- name: message-controller
paths:
  /getactivitybasedmessages:
    post:
      tags:
      - message-controller
      operationId: distributeActivityMessages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetActivityMessagesRequestDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityMessageListDTO'
  /changedistributedmessagestatus:
    post:
      tags:
      - message-controller
      operationId: updateDistributedMessageStatus
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMessageDistributionStatusRequestDTO'
        required: true
      responses:
        '200':
          description: OK
  /messages/{messageid}:
    get:
      tags:
      - message-controller
      operationId: findMessage
      parameters:
      - name: messageid
        in: path
        required: true
        schema:
          type: string
      - name: languagecode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageDTO'
  /distributedmessages/{distributedmessageid}:
    get:
      tags:
      - message-controller
      operationId: getDistributedMessage
      parameters:
      - name: distributedmessageid
        in: path
        required: true
        schema:
          type: string
      - name: languagecode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedMessageDTO'
  /appmessages:
    get:
      tags:
      - message-controller
      operationId: findAppMessages
      parameters:
      - name: merchantid
        in: query
        required: false
        schema:
          type: string
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          default: 10
      - name: languagecode
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppMessageListDTO'
components:
  schemas:
    AppMessageListDTO:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/AppMessageDTO'
        paging:
          $ref: '#/components/schemas/PagingDto'
    AppMessageDTO:
      type: object
      properties:
        distributedMessageId:
          type: string
        merchantId:
          type: string
        messageId:
          type: string
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          type: string
          enum:
          - NEW
          - READ
          - EXPIRED
          - DELETED
        distributedDate:
          type: string
        updatedDate:
          type: string
        messageType:
          type: string
        surveyId:
          type: string
        distributedEndDate:
          type: string
    UpdateMessageDistributionStatusRequestDTO:
      required:
      - distributedMessageId
      - status
      type: object
      properties:
        distributedMessageId:
          type: string
        status:
          type: string
          enum:
          - NEW
          - READ
          - EXPIRED
          - DELETED
    ActivityMessageListDTO:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ActivityMessageDTO'
    PagingDto:
      type: object
      properties:
        count:
          type: integer
          format: int32
        currentPage:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    MessageDisplayInfoDTO:
      type: object
      properties:
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
    ActivityMessageDTO:
      type: object
      properties:
        distributedMessageId:
          type: string
        merchantId:
          type: string
        messageId:
          type: string
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          type: string
          enum:
          - NEW
          - READ
          - EXPIRED
          - DELETED
        distributedDate:
          type: string
        updatedDate:
          type: string
        messageType:
          type: string
          enum:
          - PRIVATE
          - SHAREABLE
          - REFERRAL
          - SURVEY
        surveyId:
          type: string
        distributedEndDate:
          type: string
    GetActivityMessagesRequestDTO:
      required:
      - userId
      type: object
      properties:
        userId:
          type: string
        languageCode:
          type: string
        merchantId:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        events:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    DistributedMessageDTO:
      type: object
      properties:
        distributedMessageId:
          type: string
        merchantId:
          type: string
        messageId:
          type: string
        languageCode:
          type: string
        title:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        smallImage:
          type: string
        mediumImage:
          type: string
        status:
          type: string
          enum:
          - NEW
          - READ
          - EXPIRED
          - DELETED
        messageType:
          type: string
          enum:
          - PRIVATE
          - SHAREABLE
          - REFERRAL
          - SURVEY
        shareTitle:
          type: string
        shareSentence:
          type: string
        shareShortDesc:
          type: string
        shareURL:
          type: string
        distributedDate:
          type: string
        updatedDate:
          type: string
    MessageDTO:
      type: object
      properties:
        merchantId:
          type: string
        programId:
          type: string
        campaignId:
          type: string
        messageId:
          type: string
        title:
          type: string
        createdDate:
          type: string
        updatedDate:
          type: string
        noDistributed:
          type: integer
          format: int64
        messageDisplayInfo:
          type: array
          items:
            $ref: '#/components/schemas/MessageDisplayInfoDTO'
        surveyId:
          type: string
        deleted:
          type: boolean