Mavrck Notifications API

openapi: 3.2.0
info:
  version: 1.0.0
  description: Identify your most influential customers and activate them to drive more conversions on social.
  title: MAVRCK.IO Notifications API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: Notifications
paths:
  /scheduled-notifications:
    get:
      x-handler: /influencer_notifications/schedule_notification_controller.js
      operationId: getScheduledNotifications
      summary: Retrieve all scheduled notifications in a list format.
      x-access:
      - administrator
      parameters:
      - name: notificationDefinitionKeys
        in: query
        description: Select only scheduled notifications associated with these specified notification definition keys.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/orderByParam'
      - name: sent
        in: query
        schema:
          type: boolean
      - name: beforeSendTime
        in: query
        description: Select only notifications scheduled to be sent prior to this date-time.
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: An array of scheduled notifications
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    items:
                      $ref: '#/components/schemas/ScheduledNotification'
                    type: array
        '400':
          description: Invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
    post:
      x-handler: influencer_notifications/schedule_notification_controller.js
      operationId: createScheduledNotification
      summary: Create a scheduled notification
      x-access:
      - administrator
      responses:
        '200':
          description: URI for scheduled notification
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
        '400':
          description: Invalid parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Resource conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - notificationDefinitionKey
              - sendTime
              properties:
                resourceId:
                  description: Identifier of the resource contexual to the the notification (e.g. ActionGroup id)
                  type: integer
                sendTime:
                  type: string
                  format: date-time
                  description: time to send notification
                notificationDefinitionKey:
                  description: notification definition key
                  type: string
        required: true
  /scheduled-notifications/{id}:
    get:
      x-handler: influencer_notifications/schedule_notification_controller.js
      operationId: getScheduledNotification
      summary: Retrieve a single scheduled notification.
      x-access:
      - administrator
      tags:
      - Notifications
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A scheduled notification.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledNotification'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Access forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scheduled notification not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      x-handler: influencer_notifications/schedule_notification_controller.js
      operationId: updateScheduledNotification
      summary: Update a scheduled notification. Notifications that have already been sent cannot be updated.
      x-access:
      - administrator
      parameters:
      - name: id
        in: path
        description: Id of scheduled notification
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scheduled notification not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Resource conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledNotification'
        required: true
    delete:
      x-handler: influencer_notifications/schedule_notification_controller.js
      operationId: deleteScheduledNotification
      summary: Delete the specified scheduled notification. Notifications that have already been sent cannot be deleted.
      x-access:
      - administrator
      parameters:
      - name: id
        in: path
        description: Id of scheduled notification
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scheduled notification not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
  /scheduled-notifications/{id}/approval:
    put:
      x-handler: influencer_notifications/schedule_notification_approval_controller.js
      operationId: approveScheduledNotification
      summary: Approve a scheduled notification to be sent.
      x-access:
      - administrator
      parameters:
      - name: id
        in: path
        description: Id of scheduled notification
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scheduled notification not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
  /scheduled-notifications/{id}/unapproval:
    put:
      x-handler: influencer_notifications/schedule_notification_unapproval_controller.js
      operationId: unapproveScheduledNotification
      summary: Unapprove a scheduled notification to not be sent.
      x-access:
      - administrator
      parameters:
      - name: id
        in: path
        description: Id of scheduled notification
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Session expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scheduled notification not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Notifications
components:
  schemas:
    ResponseMetadata:
      properties:
        limit:
          type: number
          format: double
        offset:
          type: number
          format: double
        status:
          type: string
          enum:
          - failure
          - success
        totalCount:
          type: number
          format: double
      type: object
      additionalProperties: false
    BrandDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for a brand.
        name:
          type: string
          description: Name of the brand.
        logo:
          type: string
        accentColor:
          type: string
        buttonColor:
          type: string
        associatedWithCampaign:
          type: boolean
          description: A flag indicating whether this brand has been associated with a campaign. If this is true, then this brand cannot be deleted.
    IncentiveTermsAndConditionsDeprecated:
      type: object
      properties:
        template:
          x-access:
          - administrator
          - root
          type: string
        preview:
          type: string
        params:
          x-access:
          - administrator
          - root
          type: object
    BazaarVoiceAppProductDeprecated:
      type: object
      properties:
        reviewProductId:
          type: integer
          description: Product id assigned by Mavrck
        externalBazaarProductId:
          type: string
          description: Product id assigned by BazaarVoice
    NetworkName:
      type: string
      enum:
      - Blog
      - Facebook
      - Facebook Group
      - Facebook Live
      - Facebook Reel
      - Image
      - Instagram
      - Instagram Reel
      - Instagram Story
      - LinkedIn
      - Pinterest
      - Snapchat Story
      - TikTok
      - Twitch Stream
      - Twitter
      - Video
      - YouTube Video
      - YouTube Shorts
    MetaInformationDeprecated:
      type: object
      description: This information is pulled when an external network parses the link for meta tags.
      properties:
        title:
          type: string
        description:
          type: string
        image:
          type: string
        ftcHashtag:
          type: string
    ListDeliverable:
      properties:
        contentType:
          $ref: '#/components/schemas/NetworkSlug'
        contentTypeName:
          $ref: '#/components/schemas/NetworkName'
        count:
          type: number
          format: double
        id:
          type: number
          format: double
        listId:
          type: number
          format: double
        updatedBy:
          type: number
          format: double
      required:
      - contentType
      - contentTypeName
      - count
      - id
      - listId
      type: object
      additionalProperties: false
    IncentiveClaimDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the incentive claim.
        membershipId:
          type: integer
          x-access:
          - administrator
          - root
        globalUserId:
          type: integer
          x-access:
          - administrator
          - root
        promocode:
          type: string
          description: The issuance of a promo code. This is derived either from a static promo code configured as a property of the incentive resource or dynamically from a uploaded list of codes.
        createdAt:
          format: date-time
          type: string
        profilePictureLink:
          type: string
          x-access:
          - administrator
          - root
        firstName:
          type: string
          x-access:
          - administrator
          - root
        lastName:
          type: string
          x-access:
          - administrator
          - root
        email:
          type: string
          x-access:
          - administrator
          - root
        address:
          type: string
          x-access:
          - administrator
          - root
        age:
          type: integer
          x-access:
          - administrator
          - root
        gender:
          type: string
          x-access:
          - administrator
          - root
        facebookFriendCount:
          type: integer
          x-access:
          - administrator
          - root
        mostRecentRewardFulfilledAt:
          type: string
          format: date-time
          x-access:
          - administrator
          - root
        engagementCount:
          type: integer
        clickCount:
          type: integer
        conversionCount:
          type: integer
    ActivationURI:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          description: Unique identifier representing the activation.
        incentive:
          $ref: '#/components/schemas/IncentiveDeprecated'
        points:
          type: number
          description: The number of points earned after activating.
    IncentiveDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier representing a single incentive.
        incentiveTitle:
          type: string
          description: Short, human-readable description of the incentive displayed for influencers.
        incentiveDescription:
          type: string
          description: An elaboration on the title.
        image:
          type: string
          description: Image to associate with the incentive.
        quantity:
          type: integer
          description: The number of incentives left to claim.
        sweepstakesWinnersQty:
          type: integer
          description: The number of winners for sweepstakes.
          x-access:
          - administrator
        type:
          type: string
          description: Incentive type.
        rewardWinType:
          type: string
          description: Reward Win type of this incentive.
        sweepstakesUrl:
          type: string
          description: Sweepstakes Terms link.
        sweepsRules:
          type: string
          description: Toggle on whether a sweepstakes or contest rules are in a link or an uploaded PDF.
        promocode:
          type: string
          description: The static promo code given to distribute to influencers.
          x-access:
          - administrator
        multipleClaims:
          type: boolean
          description: Whether this incentive allows for multiple claims.
        promocodeTermsAndConditions:
          type: string
          description: Promocode terms and conditions.
        exclusiveLinkUrl:
          type: string
          description: Url where Influencer can claim incentive.
        exclusiveLinkCta:
          type: string
          description: Button copy to be displayed for Influencer
        contestMetric:
          type: string
          description: For contest type incentives, this determines the metric in which winners are selection (clickCount, conversionCount, or engagementCount).
        printableCoupon:
          type: string
          description: Printable coupon URL
        rewardId:
          type: string
          description: Generated unique identifier of a reward.
        winnerSelectionMethod:
          type: string
          x-access:
          - administrator
          - root
          description: Selection method used for influencer winners.
        winnersSelectedCount:
          type: integer
          x-access:
          - administrator
          - root
          description: For incentives tied to expired action groups, this indicates the number of winners that have already been selected.
        disqualifiedWinnersCount:
          type: integer
          x-access:
          - administrator
          - root
          description: For incentives tied to expired action groups, this indicates the number of winners that have been disqualified.
        allocatedWinnersCount:
          type: integer
          x-access:
          - administrator
          - root
          description: For incentives tied to expired action groups, this indicates the number of winners that were allocated to this incentive.
        claimedIncentivesInfluencerCount:
          type: integer
          x-access:
          - administrator
          - root
          description: This indicates the number of influencers that claimed this incentive.
        claimedIncentivesCount:
          type: integer
          x-access:
          - administrator
          - root
          description: This indicates the number of claims on this incentive.
        actionGroupId:
          type: integer
          description: ID of the parent action group.
        cashPaymentAppId:
          type: integer
          description: ID the associated cash payment app.
        giftCardOptionId:
          type: integer
          description: ID the associated gift card option.
        giftCardEmailTemplateId:
          type: string
          description: ID the associated gift card email template (External Id).
        actionGroupStatus:
          type: string
          description: Lifecycle status of the parent action group.
        incentiveStatus:
          type: string
          description: Status of the incentive, which is relevant for non-activity incentives only.
        claims:
          type: array
          items:
            $ref: '#/components/schemas/IncentiveClaimDeprecated'
        endDate:
          format: date-time
          type:
          - string
          - 'null'
        startDate:
          format: date-time
          type:
          - string
          - 'null'
        unlockType:
          type: string
          description: Method of unlocking the incentive.
        numberPointsRequired:
          type: integer
          description: For points unlocked incentives, the number of points requires to unlock this incentive.
        approximateRetailValue:
          type: number
          description: The Approximate Retail Value of the incentive being rewarded.
          x-access:
          - administrator
        cost:
          type: number
          description: The Cost of the incentive being rewarded.
          x-access:
          - administrator
        costCurrencyCode:
          type: string
          description: Cost Currency Code.
          x-access:
          - administrator
        valueCurrencyCode:
          type: string
          description: Cost Currency Code.
          x-access:
          - administrator
        bonusTierCurrencyCode:
          type:
          - string
          - 'null'
          enum:
          - USD
          - EUR
          - GBP
          - AUD
          - CAD
          - null
          description: Currency code used for all tiered bonus amounts. Required when `bonusTiers` is non-empty.
          x-access:
          - administrator
        bonusTiers:
          type:
          - array
          - 'null'
          description: Tiered bonus payout ladder. Sorted, contiguous, at most 5 tiers, ending with one `OPEN_ENDED` tier.
          items:
            $ref: '#/components/schemas/BonusTier'
          x-access:
          - administrator
        termsAndConditions:
          $ref: '#/components/schemas/IncentiveTermsAndConditionsDeprecated'
        totalDynamicPromoCodes:
          type: number
          description: The total number of dynamic promo codes across all groups for this incentive
          x-access:
          - administrator
        claimedDynamicPromoCodes:
          type: number
          description: The number of claimed dynamic promo codes across all groups for this incentive
          x-access:
          - administrator
        unlockEvent:
          type: string
          enum:
          - completion
          - acceptance
          - pending_shipment
          - pending_payment
        cashPaymentAppProvider:
          type: string
          description: Cash Payment App Provider
        discountCodeId:
          type: string
          description: Discount code ID
        couponActivation:
          type: string
          description: Coupon Activation
    RoutingOptionsDeprecated:
      type: object
      description: Routing options
      properties:
        redirect_url:
          type: string
          description: Url the influencer should be redirected to.
        cta:
          type: string
          description: Displayed CTA.
        mode:
          type: string
          description: Routing type.
    InfluencerDataPointCriteriaDeprecated:
      type: object
      required:
      - key
      properties:
        key:
          type: string
        value:
          type:
          - string
          - boolean
          - integer
        values:
          type: array
          items:
            type: string
        minValue:
          type: integer
        maxValue:
          type: integer
    PowerReviewsPageDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: id of the product
        reviewProductId:
          type: integer
          description: the power reviews id
        powerReviewsAppId:
          type: string
          description: the product id
        externalPageId:
          type: string
          description: product image url
        PowerReviewsApp:
          type: object
          items:
            $ref: '#/components/schemas/PowerReviewsAppDeprecated'
    AudienceDeprecated:
      type: object
      x-access:
      - root
      - administrator
      properties:
        id:
          type: integer
          description: Unique identifier representing a single audience.
        name:
          type: string
          description: Human-readable description of the audience displayed to administrators.
        criteria:
          type: array
          items:
            $ref: '#/components/schemas/InfluencerDataPointCriteriaDeprecated'
    LinksDeprecated:
      type: object
      x-access:
      - anonymous
      - influencer
      properties:
        normal:
          type: string
          description: A normal link to an entity.
        deep:
          type: string
          description: A deep link to the entity.
    MembershipDeprecated:
      type: object
      properties:
        id:
          description: id and membershipId are equivalent.
          type: integer
        membershipId:
          description: id and membershipId are equivalent.
          type: integer
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        membershipType:
          type: string
        blacklisted:
          type: boolean
        utmContent:
          type: string
        utmCampaign:
          type: string
        contactInfo:
          $ref: '#/components/schemas/MembershipContactInfoDeprecated'
        pointsCurrentBalance:
          type: object
          properties:
            amount:
              type: integer
        totalPoints:
          type: integer
        mostRecentActivationDate:
          type: string
          format: date
        totalImpressions:
          type: number
        imageUrl:
          type: string
        lifetimeClicks:
          type: integer
        lifetimeConversions:
          type: integer
        lifetimeConversionsValue:
          type: number
    MembershipContactInfoDeprecated:
      properties:
        age:
          type: number
          format: double
        apt:
          type: string
        birthday:
          type: object
        city:
          type: string
        country:
          type: string
        email:
          type: string
        emailIsVerified:
          type: boolean
        firstName:
          type: string
        fullName:
          type: string
        gender:
          $ref: '#/components/schemas/Gender'
        genderDescription:
          type: string
        lastName:
          type: string
        phone:
          type: string
        state:
          type: string
        street:
          type: string
        zip:
          type: string
        talentManagerEmail:
          type: string
      type: object
      additionalProperties: false
    ConversionTagDeprecated:
      type: object
      x-access:
      - administrator
      - root
      properties:
        id:
          type: string
          description: Unique identifier for the conversion tag.
        name:
          type: string
          description: Human-readable name for the conversion tag.
        code:
          type: string
          description: Code to embed in the Clickmeter JavaScript snippet to conduct conversion tracking.
        type:
          type: string
          description: The category this conversion belongs. One of the set {"purchase", "app_download", "sign_up"}.
        isActive:
          type: boolean
          description: Determines if a conversion tag is active or inactive
        isConversionValueEnabled:
          type: boolean
          description: Determines if a conversion tag is active or inactive
    ActionGroupDeprecated:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier representing a single action group.
        communityId:
          type: string
        communityName:
          type: string
        communityImage:
          type: string
        type:
          type: string
        mainType:
          type: string
          description: First action in the group type
        name:
          type: string
          description: Human-readable description of the action group displayed for administrators.
          x-access:
          - root
          - administrator
        title:
          type: string
        description:
          type: string
        image:
          type: string
        contentType:
          type: string
          description: For content action groups, this provides the type of content, which either matches og:image or is derived from internal heuristics.
        url:
          type: string
          description: For content action groups, this contains the url input upon creation.
        status:
          type: string
          description: The state of the action group. One of the set {"LIVE", "PAUSED", "PENDING", "EXPIRED"}.
          x-access:
          - root
          - administrator
        startDate:
          format: date-time
          type: string
          description: The scheduled time in which the action group will become available to influencers.
        endDate:
          format: date-time
          type:
          - 'null'
          - string
          description: The scheduled time in which the action group will no longer b

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