mammoth-io

mammoth-io Deals Support API

The Deals Support API from mammoth-io — 6 operation(s) for deals support.

GitHub OpenAPI

Operations 9

POST /support/deals/{deal_id}/move-to-partner Move a direct deal under a partner #
DELETE /support/deals/{deal_id}/move-to-partner Cancel a scheduled move under a partner #
GET /support/deals List deals #
POST /support/deals Create deal #
GET /support/deals/{deal_id}/activity Deal activity feed #
GET /support/deals/{deal_id} Get deal #
PUT /support/deals/{deal_id} Update deal #
POST /support/deals/{deal_id}/opt-in Opt a deal in to catalog changes #
GET /support/deals/{deal_id}/preview-entitlement Preview a deal's resolved entitlement #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mammoth-io/openapi/mammoth-io-deals-support-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-workspace-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-datasets-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-activity-filters-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-automation-creation-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-dataview-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-update-plan-request-schema-schema.json

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/mammoth-io:mammoth-io-deals-support-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

mammoth-io-deals-support-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mammoth Io Deals Support API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Deals Support across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Deals Support
paths:
  /support/deals/{deal_id}/move-to-partner:
    post:
      tags:
      - Deals Support
      summary: Move a direct deal under a partner
      description: Schedule the move at the workspace's period end (default) or run it now. Refused for a partner deal, an unpaid workspace, a pending detach or move, or a partner whose billing is stopped.
      operationId: SupportDealMoveToPartner
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealMoveToPartner'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealMoveResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    delete:
      tags:
      - Deals Support
      summary: Cancel a scheduled move under a partner
      operationId: SupportDealCancelMoveToPartner
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/deals:
    get:
      tags:
      - Deals Support
      summary: List deals
      operationId: SupportListDeals
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealListResponse'
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    post:
      tags:
      - Deals Support
      summary: Create deal
      operationId: SupportCreateDeal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealCreate'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealIdsResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/deals/{deal_id}/activity:
    get:
      tags:
      - Deals Support
      summary: Deal activity feed
      operationId: SupportDealActivity
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealActivityResponse'
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Validation Exception
                examples:
                - status_code: 400
                  detail: Bad Request
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/deals/{deal_id}:
    get:
      tags:
      - Deals Support
      summary: Get deal
      operationId: SupportGetDeal
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    put:
      tags:
      - Deals Support
      summary: Update deal
      operationId: SupportUpdateDeal
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealUpdate'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealIdsResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/deals/{deal_id}/opt-in:
    post:
      tags:
      - Deals Support
      summary: Opt a deal in to catalog changes
      description: 'Release the deal''s opt-in rollout pins so the named keys and connectors (or all, with `all: true`) follow the base plan again.'
      operationId: SupportDealOptIn
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealOptIn'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealPinsResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /support/deals/{deal_id}/preview-entitlement:
    get:
      tags:
      - Deals Support
      summary: Preview a deal's resolved entitlement
      operationId: SupportPreviewDealEntitlement
      parameters:
      - name: deal_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DealEntitlementResponse'
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                oneOf:
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Client Error
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
                - properties:
                    status_code:
                      type: integer
                    detail:
                      type: string
                    extra:
                      additionalProperties: {}
                      type:
                      - 'null'
                      - object
                      - array
                  type: object
                  required:
                  - detail
                  - status_code
                  description: Validation Exception
                  examples:
                  - status_code: 400
                    detail: Bad Request
                    extra: {}
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    DealUpdate:
      properties:
        price:
          oneOf:
          - type: string
          - type: 'null'
        billing_interval:
          oneOf:
          - type: string
          - type: 'null'
        collection_method:
          oneOf:
          - type: string
          - type: 'null'
        currency:
          oneOf:
          - type: string
          - type: 'null'
        base_plan_id:
          oneOf:
          - type: integer
          - type: 'null'
        ent_overrides:
          oneOf:
          - additionalProperties:
              oneOf:
              - type: integer
              - type: boolean
              - type: string
              - type: 'null'
            type: object
          - type: 'null'
        custom_connectors:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        contract_start:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        contract_end:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        trial_end:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        payment_terms:
          oneOf:
          - type: string
          - type: 'null'
        notes:
          oneOf:
          - type: string
          - type: 'null'
        contact_name:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 128
        contact_email:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 256
        status:
          oneOf:
          - type: string
          - type: 'null'
        customer_email:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 128
      type: object
      required: []
      title: DealUpdate
    DealPinsResponse:
      properties:
        pins:
          additionalProperties:
            additionalProperties:
              oneOf:
              - type: integer
              - type: boolean
              - type: string
              - type: 'null'
            type: object
          type: object
      type: object
      required:
      - pins
      title: DealPinsResponse
    MessageResponse:
      properties:
        message:
          type: string
      type: object
      required:
      - message
      title: MessageResponse
    WorkspaceCreateForDeal:
      properties:
        name:
          type: string
        user_email:
          type: string
      type: object
      required:
      - name
      - user_email
      title: WorkspaceCreateForDeal
    DealMoveToPartner:
      properties:
        partner_id:
          type: integer
        price:
          type: number
          minimum: 0.0
        billing_interval:
          type: string
        when:
          type: string
          enum:
          - period_end
          - now
          default: period_end
      type: object
      required:
      - billing_interval
      - partner_id
      - price
      title: DealMoveToPartner
    DealIdsResponse:
      properties:
        id:
          type: integer
        workspace_id:
          type: integer
      type: object
      required:
      - id
      - workspace_id
      title: DealIdsResponse
    DealActivityResponse:
      properties:
        activity:
          items:
            additionalProperties: {}
            type: object
          type: array
      type: object
      required:
      - activity
      title: DealActivityResponse
    DealOptIn:
      properties:
        keys:
          items:
            type: string
          type: array
        connectors:
          items:
            type: string
          type: array
        all:
          type: boolean
          default: false
      type: object
      required: []
      title: DealOptIn
    DealCreate:
      properties:
        price:
          oneOf:
          - type: string
          - type: 'null'
        billing_interval:
          oneOf:
          - type: string
          - type: 'null'
        collection_method:
          oneOf:
          - type: string
          - type: 'null'
        currency:
          oneOf:
          - type: string
          - type: 'null'
        base_plan_id:
          type: integer
        ent_overrides:
          oneOf:
          - additionalProperties:
              oneOf:
              - type: integer
              - type: boolean
              - type: string
              - type: 'null'
            type: object
          - type: 'null'
        custom_connectors:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        contract_start:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        contract_end:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        trial_end:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        payment_terms:
          oneOf:
          - type: string
          - type: 'null'
        notes:
          oneOf:
          - type: string
          - type: 'null'
        contact_name:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 128
        contact_email:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 256
        workspace_id:
          oneOf:
          - type: integer
          - type: 'null'
        workspace_create:
          oneOf:
          - $ref: '#/components/schemas/WorkspaceCreateForDeal'
          - type: 'null'
        customer_email:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 128
        partner_id:
          oneOf:
          - type: integer
          - type: 'null'
        billing_start:
          type:
          - 'null'
          - string
          enum:
          - now
          - chargebee_term_end
          - date
          - null
        billing_start_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        status:
          type:
          - 'null'
          - string
          enum:
          - active
          - trial
          - null
      type: object
      required:
      - base_plan_id
      title: DealCreate
    DealListResponse:
      properties:
        deals:
          items:
            additionalProperties: {}
            type: object
          type: array
      type: object
      required:
      - deals
      title: DealListResponse
    DealMoveResponse:
      properties:
        move:
          oneOf:
          - additionalProperties: {}
            type: object
          - type: 'null'
      type: object
      required: []
      title: DealMoveResponse
    DealResponse:
      properties:
        deal:
          additionalProperties: {}
          type: object
      type: object
      required:
      - deal
      title: DealResponse
    DealEntitlementResponse:
      properties:
        entitlement:
          additionalProperties: {}
          type: object
      type: object
      required:
      - entitlement
      title: DealEntitlementResponse
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json