Opply

Opply Welcome Modal API

The Welcome Modal API from Opply — 1 operation(s) for welcome modal.

Documentation GitHub OpenAPI

Operations 2

GET /api/v1/users/welcome-modal/me/ #

POST /api/v1/users/welcome-modal/me/ #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/opply/refs/heads/main/openapi/opply-welcome-modal-api-openapi.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/opply-welcome-modal-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

openapi: 3.2.0
info:
  title: Opply Activity Feed Welcome Modal API
  version: 0.0.0
servers:
- url: https://api.opply.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Welcome Modal
paths:
  /api/v1/users/welcome-modal/me/:
    get:
      operationId: api_v1_users_welcome_modal_me_retrieve
      description: Per-user dismissal state for the post-relaunch welcome modal.
      tags:
      - Welcome Modal
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WelcomeModalState'
          description: ''
    post:
      operationId: api_v1_users_welcome_modal_me_create
      description: Per-user dismissal state for the post-relaunch welcome modal.
      tags:
      - Welcome Modal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WelcomeModalDismissalRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WelcomeModalDismissalRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WelcomeModalDismissalRequest'
        required: true
      security:
      - tokenAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WelcomeModalDismissal'
          description: ''
components:
  schemas:
    NullEnum:
      enum:
      - null
    WelcomeModalActionEnum:
      enum:
      - place_an_order
      - payments
      - explore
      type: string
      description: '* `place_an_order` - Place an order

        * `payments` - Payments

        * `explore` - Explore'
    WelcomeModalDismissal:
      type: object
      properties:
        action:
          allOf:
          - $ref: '#/components/schemas/WelcomeModalActionEnum'
          description: 'Which CTA the user chose when dismissing the welcome modal.


            * `place_an_order` - Place an order

            * `payments` - Payments

            * `explore` - Explore'
        dismissed_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - action
      - dismissed_at
    WelcomeModalState:
      type: object
      description: Response shape for `GET /users/welcome-modal/me/`.
      properties:
        dismissed:
          type: boolean
        action:
          oneOf:
          - $ref: '#/components/schemas/WelcomeModalActionEnum'
          - $ref: '#/components/schemas/NullEnum'
        dismissed_at:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - action
      - dismissed
      - dismissed_at
    WelcomeModalDismissalRequest:
      type: object
      description: Inbound payload for `POST /users/welcome-modal/me/`.
      properties:
        action:
          $ref: '#/components/schemas/WelcomeModalActionEnum'
      required:
      - action
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"