upGrad

upGrad Prospect Controller API

The prospect-controller API from upGrad — 3 operation(s) for prospect-controller.

GitHub OpenAPI

Operations 4

PUT /vpc-only/prospect/{leadId}/{lsqEmail} Update prospect #
GET /prospect Get prospects #
POST /prospect Save prospect #
GET /prospect/{prospectId}/lead/{leadId} Get prospect #

Documentation

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

Specifications

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

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/upgrad/refs/heads/main/errors/upgrad-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/upgrad/refs/heads/main/data-model/upgrad-data-model.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/upgrad-prospect-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

upgrad-prospect-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Partner Service Prospect Controller API
  license:
    name: Apache 2.0
    url: https://upgrad.com
  version: '1'
servers:
- url: https://partner.upgrad.com
  description: Generated server url
security:
- AUTH-TOKEN: []
tags:
- name: prospect-controller
paths:
  /vpc-only/prospect/{leadId}/{lsqEmail}:
    put:
      tags:
      - prospect-controller
      operationId: updateProspect
      parameters:
      - name: leadId
        in: path
        required: true
        schema:
          type: string
      - name: lsqEmail
        in: path
        required: true
        schema:
          type: string
      responses:
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '405':
          description: Method Not Allowed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '503':
          description: Service Unavailable
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '200':
          description: OK
      summary: Update prospect
      x-summary-source: derived
  /prospect:
    get:
      tags:
      - prospect-controller
      operationId: getProspects
      parameters:
      - name: pageable
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/Pageable'
      - name: prospectFilter
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/ProspectFilterDto'
      responses:
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '405':
          description: Method Not Allowed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '503':
          description: Service Unavailable
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseProspectDto'
      summary: Get prospects
      x-summary-source: derived
    post:
      tags:
      - prospect-controller
      operationId: saveProspect
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProspectDto'
        required: true
      responses:
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '405':
          description: Method Not Allowed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '503':
          description: Service Unavailable
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProspectDto'
      summary: Save prospect
      x-summary-source: derived
  /prospect/{prospectId}/lead/{leadId}:
    get:
      tags:
      - prospect-controller
      operationId: getProspect
      parameters:
      - name: prospectId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: leadId
        in: path
        required: true
        schema:
          type: string
      responses:
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '405':
          description: Method Not Allowed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '503':
          description: Service Unavailable
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '429':
          description: Too Many Requests
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorContext'
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProspectDto'
      summary: Get prospect
      x-summary-source: derived
components:
  schemas:
    ProspectDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        userId:
          type: integer
          format: int64
        leadId:
          type: string
        status:
          type: integer
          format: int32
        teamMemberId:
          type: integer
          format: int64
        goal:
          type: string
        fullName:
          type: string
        email:
          type: string
        mobile:
          type: integer
          format: int64
        countryCode:
          type: integer
          format: int32
        city:
          type: string
        course:
          type: string
        platform:
          type: string
        extraFields:
          type: object
          additionalProperties:
            type: object
        statusLabel:
          type: string
        created:
          type: string
          format: date-time
        memberDetail:
          $ref: '#/components/schemas/UserDto'
        university:
          type: string
        universityName:
          type: string
        courseName:
          type: string
    ErrorContext:
      type: object
      properties:
        errorCode:
          type: string
        messages:
          type: array
          items:
            type: string
        data:
          type: object
          additionalProperties:
            type: object
    PageResponseProspectDto:
      type: object
      properties:
        total:
          type: integer
          format: int64
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProspectDto'
    UserDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        email:
          type: string
        mobile:
          type: integer
          format: int64
        countryCode:
          type: integer
          format: int32
        fullName:
          type: string
        role:
          type: string
        alternateEmail:
          type: string
        password:
          type: string
        permission:
          type: string
    Pageable:
      type: object
      properties:
        page:
          minimum: 0
          type: integer
          format: int32
        size:
          minimum: 1
          type: integer
          format: int32
        sort:
          type: array
          items:
            type: string
    ProspectFilterDto:
      type: object
      properties:
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        teamMemberId:
          type: integer
          format: int64
        teamMemberIds:
          uniqueItems: true
          type: array
          items:
            type: integer
            format: int64
        userId:
          type: integer
          format: int64
        leadId:
          type: string
        status:
          type: integer
          format: int32
        goal:
          type: array
          items:
            type: string
        fullName:
          type: string
        email:
          type: string
        mobile:
          type: integer
          format: int64
        countryCode:
          type: integer
          format: int32
        city:
          type: string
        course:
          type: string
        platform:
          type: string
  securitySchemes:
    AUTH-TOKEN:
      type: apiKey
      name: AUTH-TOKEN
      in: header