Mavrck

Mavrck Account Invitations API

The AccountInvitations API from Mavrck — 5 operation(s) for accountinvitations.

GitHub OpenAPI

Documentation

📖
Documentation
https://help-influence.later.com/hc/en-us
📖
APIReference
https://api.mavrck.co/api-docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/authentication/mavrck-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/openapi/mavrck-accountinvitations-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/mavrck/refs/heads/main/overlays/mavrck-platform-servers-overlay.yaml

OpenAPI Specification

mavrck-accountinvitations-api-openapi.yml Raw ↑ 
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 Account Invitations API
servers:
- url: http://app.splashscore.com/v1
- url: https://app.splashscore.com/v1
security:
- apiKey: []
tags:
- name: AccountInvitations
paths:
  /v1/account-invitations:
    get:
      operationId: getAccountInvitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBody_AccountInvitationDomain-Array_'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: query
        name: communityId
        required: true
        schema:
          type: string
      - in: query
        name: limit
        required: false
        schema:
          type: number
          format: double
      - in: query
        name: offset
        required: false
        schema:
          type: number
          format: double
    post:
      operationId: postAccountInvitation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInvitationDomain'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountActivationPostRequestBody'
        required: true
  /v1/account-invitations/{id}:
    put:
      operationId: putAccountInvitation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInvitationDomain'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountActivationPutRequestBody'
        required: true
    delete:
      operationId: deleteAccountInvitation
      responses:
        '200':
          description: OK
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/account-invitations/{id}/refresh:
    post:
      operationId: refreshAccountInvitation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInvitationDomain'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: number
          format: double
  /v1/account-invitations/accept:
    get:
      operationId: acceptAccountInvitation
      responses:
        '302':
          description: Redirect
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: query
        name: signature
        required: true
        schema:
          type: string
  /v1/account-invitations/post-registration:
    get:
      operationId: postRegistration
      responses:
        '302':
          description: Redirect
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateErrorJSON'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '500':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerError'
      tags:
      - AccountInvitations
      parameters:
      - in: query
        name: signature
        required: true
        schema:
          type: string
components:
  schemas:
    AccountActivationPostRequestBody:
      properties:
        communityId:
          type: string
        email:
          type: string
        inviteeRoleId:
          type: number
          format: double
      required:
      - communityId
      - email
      - inviteeRoleId
      type: object
      additionalProperties: false
    AccountActivationPutRequestBody:
      properties:
        email:
          type: string
        inviteeRoleId:
          type: number
          format: double
      type: object
      additionalProperties: false
    ResponseBody_AccountInvitationDomain-Array_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/AccountInvitationDomain'
          type: array
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
      - data
      type: object
      additionalProperties: false
    ResponseMeta:
      properties:
        limit:
          type: number
          format: double
        offset:
          type: number
          format: double
        totalCount:
          type: number
          format: double
      type: object
      additionalProperties: false
    ForbiddenError:
      properties:
        message:
          type: string
          enum:
          - Access Forbidden
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
    ServerError:
      properties:
        message:
          type: string
          enum:
          - Server Error
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      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
    AccountInvitationDomain:
      properties:
        communityId:
          type: string
        createdAt:
          type: string
        email:
          type: string
        mailerStatus:
          type: object
        expiresAt:
          type: string
        fulfilledByAccountId:
          type:
          - number
          - 'null'
          format: double
        id:
          type: number
          format: double
        inviteeRoleId:
          type: number
          format: double
        updatedAt:
          type: string
      required:
      - communityId
      - createdAt
      - email
      - mailerStatus
      - expiresAt
      - fulfilledByAccountId
      - id
      - inviteeRoleId
      - updatedAt
      type: object
      additionalProperties: false
    ValidateErrorJSON:
      properties:
        message:
          type: string
          enum:
          - Validation failed
        details:
          properties: {}
          additionalProperties:
            additionalProperties: true
          type: object
      required:
      - message
      - details
      type: object
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: apiKey
      name: api-key
      in: header