Mavrck Application 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 Application API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: Application
paths:
  /action-groups/{id}/application:
    get:
      x-handler: action_group_candidates/action_group_application_controller.js
      summary: Retrieve an individual application.
      operationId: getActionGroupApplication
      x-sharedCipherParameters:
        actionGroupId: id
      parameters:
      - name: id
        in: path
        description: ID of action group
        required: true
        schema:
          type: integer
      - name: communityId
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Application for an activity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '400':
          description: Invalid parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Action group 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:
      - Application
    put:
      x-handler: action_group_candidates/action_group_application_controller.js
      x-access:
      - administrator
      summary: Update an application for an action group.
      operationId: updateActionGroupApplication
      parameters:
      - name: id
        in: path
        description: ID of action group
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Bad request
          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: Resource non-existent
          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:
      - Application
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Application'
  /action-groups/{id}/submissions:
    post:
      x-handler: action_group_candidates/action_group_application_submission_controller.js
      x-access:
      - influencer
      summary: Create a submission for an application.
      operationId: submitApplication
      parameters:
      - name: id
        in: path
        description: ID of action group
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Empty object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyObject'
        '400':
          description: Bad request
          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: Either the campaign or audience was 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:
      - Application
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/UserDataPoint'
  /v1/action-groups/{actionGroupId}/application-flow:
    get:
      operationId: getApplicationFlow
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationStates'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: The resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - Application
      parameters:
      - in: path
        name: actionGroupId
        required: true
        schema:
          type: number
          format: double
components:
  schemas:
    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.
    ConversationTemplateDeprecated:
      type: object
      properties:
        id:
          type: integer
        category:
          type: string
        title:
          type: string
        subject:
          type: string
        html:
          type: string
        createdBy:
          $ref: '#/components/schemas/AdministratorDeprecated'
        lastModifiedBy:
          $ref: '#/components/schemas/AdministratorDeprecated'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deliveryMethod:
          type: string
        sendOnEvent:
          type: string
        sendOnDays:
          type: integer
        sendOnTimeframe:
          type: string
        sendOnStatusId:
          type:
          - integer
          - 'null'
        sendOnDate:
          type: string
        slug:
          type: string
        isArchived:
          type: boolean
    BazaarVoiceAppProductDeprecated:
      type: object
      properties:
        reviewProductId:
          type: integer
          description: Product id assigned by Mavrck
        externalBazaarProductId:
          type: string
          description: Product id assigned by BazaarVoice
    IncentiveTermsAndConditionsDeprecated:
      type: object
      properties:
        template:
          x-access:
          - administrator
          - root
          type: string
        preview:
          type: string
        params:
          x-access:
          - administrator
          - root
          type: object
    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
    ReviewFormDeprecated:
      type: object
      required:
      - questions
      properties:
        id:
          type: integer
          description: id of form
        reviewProductId:
          type: integer
        action:
          $ref: '#/components/schemas/ActionDeprecated'
        product:
          $ref: '#/components/schemas/ProductDeprecated'
        questions:
          type: array
          description: Array of form questions
          items:
            $ref: '#/components/schemas/QuestionDeprecated'
        title:
          type: string
        description:
          type: string
        url:
          type: string
        incentivized:
          x-access:
          - administrator
          - root
          type: boolean
          description: whether the form is incentivized
        responses:
          type: array
          x-access:
          - administrator
          - root
          items:
            type: object
            properties:
              membership:
                $ref: '#/components/schemas/MembershipDeprecated'
              questionResponses:
                type: array
                items:
                  type: object
    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.
    ApplicationStates:
      properties:
        data:
          items:
            type: string
          type: array
      required:
      - data
      type: object
    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
    ForbiddenError:
      properties:
        message:
          type: string
          enum:
          - Access Forbidden
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
    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
    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
    UserDataPoint:
      type: object
      properties:
        key:
          type: string
          description: Key for the data point.
          x-access:
          - root
          - administrator
        value:
          type: array
          items:
            type: string
          description: Values of the data point for the given influencer user
          x-access:
          - root
          - administrator
    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
    NotFoundError:
      properties:
        message:
          type: string
          enum:
          - Resource Not Found
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      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
    WorkflowStatusRequirementDeprecated:
      type: object
      properties:
        satisfied:
          type: boolean
        incentiveId:
          type: number
        name:
          type: string
    ActionDeprecated:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier representing a single action.
        type:
          type: string
          description: A key to specify the type of action.
        title:
          type: string
          description: A concise call to action, grabbing the influencer's attention.
        label:
          type: string
          description: Internal label for action.
        description:
          type: string
          description: An elaboration on the title.
        image:
          type: string
          description: An image to associate with the action.
        instructions:
          type: string
          description: Instructions on how to complete the action
        linkReference:
          type: string
          description: Reference to Link
        actionGroupId:
          type: integer
          x-access:
          - administrator
          - root
          - influencer
          description: ID of the parent action group.
        actionGroupType:
          type: string
          x-access:
          - administrator
          - root
          description: Type of the parent action group.
        actionGroupTitle:
          type: string
        brandSuitabilityGuidelines:
          type:
          - 'null'
          - string
          description: Optional guidelines from the parent action group to customize the brand suitability review for this action's campaign.
        ActionGroup:
          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 be available to influencers.
            createdAt:
              format: date-time
              type:
              - 'null'
              - string
            notInCommunity:
              type: boolean
              x-access:
              - root
              - administrator
              description: Filter this action group if the client specifies channel=community.
            isAutoCreated:
              type: boolean
            isPrimaryReferralActivity:
              type: boolean
            multipleActivations:
              type: boolean
              description: Indicates whether this action group can be completed multiple times. Only available for photoChallenge.
            campaign:
              type: object
              x-access:
              - root
              - administrator
              properties:
                id:
                  type: integer
                  description: Unique identifier representing a single campaign.
                name:
                  type: string
                  description: Name of campaign.
                description:
                  type: string
                  description: Name of campaign.
                brand:
                  $ref: '#/components/schemas/BrandDeprecated'
                hasActivations:
                  type: boolean
                  description: Flag that indicates whether this campaign is associated with any activations.
                createdAt:
                  format: date-time
                  type: string
                  description: The date and time that the campaign was created.
            audience:
              $ref: '#/components/schemas/AudienceDeprecated'
            incentive:
              $ref: '#/components/schemas/IncentiveDeprecated'
            incentives:
              items:
                $ref: '#/components/schemas/IncentiveDeprecated'
              type: array
            points:
              type: object
              properties:
                min:
                  type: integer
                max:
                  type: integer
            hasScheduledNotifications:
              type: boolean
              description: Indicates whether the action group is t

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