Proton.ai

Proton.ai Custom Fields API

The Custom Fields API from Proton.ai — 5 operation(s) for custom fields.

GitHub OpenAPI

Operations 5

POST /{company}/custom_field/create Add new custom field #
POST /{company}/custom_field/delete Delete a custom field #
PUT /{company}/custom_field/edit Edit a custom field configuration #
GET /{company}/custom_field/all Get all custom fields #
PUT /{company}/custom_field/update_instance Update a custom field instance #

Documentation

📖
Authentication
https://artifacts.apis.io/protonai/authentication/protonai-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/protonai/openapi/protonai-custom-fields-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/protonai/conventions/protonai-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/protonai/errors/protonai-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/protonai/data-model/protonai-data-model.yml
🔗
Lifecycle
https://artifacts.apis.io/protonai/lifecycle/protonai-lifecycle.yml
🔗
Conformance
https://artifacts.apis.io/protonai/conformance/protonai-conformance.yml
🔗
LLMsTxt
https://artifacts.apis.io/protonai/llms/protonai-llms.txt

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/protonai:protonai-custom-fields-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

protonai-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Proton Custom Fields API
  version: 1.0.0
  description: The Proton API is an AI-powered suite of REST endpoints for product recommendations and CRM actions (customers, contacts, opportunities, quotes, leads, call notes, tasks, tracking) for B2B distributors. Requests require a static API key in the X-Api-Key header, supplied by Proton at the start of an integration. Derived by API Evangelist from the provider's published public Postman documentation at https://api.proton.ai/.
  contact:
    name: Proton.ai
    url: https://www.proton.ai/
servers:
- url: https://api.proton.ai
  description: 'Production (tenant path: /{company}/...)'
security:
- ApiKeyAuth: []
tags:
- name: Custom Fields
paths:
  /{company}/custom_field/create:
    post:
      operationId: addNewCustomField
      summary: Add new custom field
      tags:
      - Custom Fields
      description: field_id is optional. If left out, the system will generate a globally unique field_id for you.
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
      - name: X-User-Id
        in: header
        required: false
        schema:
          type: string
        description: Acting user id
      - name: X-Company
        in: header
        required: true
        schema:
          type: string
        description: Tenant company slug
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              display_name: Good Dancer?
              display_description: Summary judgement on the individual's musical aptitude
              field_type: dropdown
              options:
              - 'Yes'
              - 'No'
              - Depends on the music
              required: true
              record_types:
              - opportunity
              editability:
              - admin
              visibility:
              - admin
              - manager
              config:
                opportunity__pipeline_id: some_pipeline_id
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
  /{company}/custom_field/delete:
    post:
      operationId: deleteACustomField
      summary: Delete a custom field
      tags:
      - Custom Fields
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
      - name: X-User-Id
        in: header
        required: false
        schema:
          type: string
        description: Acting user id
      - name: X-Company
        in: header
        required: true
        schema:
          type: string
        description: Tenant company slug
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              custom_field_id: custom_usesi_jm_awarded_date
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
  /{company}/custom_field/edit:
    put:
      operationId: editACustomFieldConfiguration
      summary: Edit a custom field configuration
      tags:
      - Custom Fields
      description: 'field_id is required. Every other parameter is optional*.

        *If you change the custom field''s type to dropdown, then options will also be a required parameter.'
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
      - name: X-User-Id
        in: header
        required: false
        schema:
          type: string
        description: Acting user id
      - name: X-Company
        in: header
        required: true
        schema:
          type: string
        description: Tenant company slug
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              custom_field_id: test percentage
              display_name: Probability%
              display_description: ''
              field_type: percentage
              lookup_target: null
              required: true
              display_order: 800
              record_types:
              - opportunity
              editability:
              - all
              visibility:
              - all
              is_ingested: false
              conditional_logic: null
              config:
                opportunity__pipeline_id: QN3iL5Y7zyrvDJXFQjPJva
              group: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
  /{company}/custom_field/all:
    get:
      operationId: getAllCustomFields
      summary: Get all custom fields
      tags:
      - Custom Fields
      description: To retrieve all custom fields, remove record_types from the URL.
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
      - name: X-User-Id
        in: header
        required: false
        schema:
          type: string
        description: Acting user id
      - name: X-Company
        in: header
        required: true
        schema:
          type: string
        description: Tenant company slug
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
  /{company}/custom_field/update_instance:
    put:
      operationId: updateACustomFieldInstance
      summary: Update a custom field instance
      tags:
      - Custom Fields
      parameters:
      - name: company
        in: path
        required: true
        schema:
          type: string
      - name: X-User-Id
        in: header
        required: false
        schema:
          type: string
        description: Acting user id
      - name: X-Company
        in: header
        required: true
        schema:
          type: string
        description: Tenant company slug
      requestBody:
        content:
          application/json:
            schema:
              type: object
            example:
              record_type: contact
              record_id: '125246'
              custom_field_id: '1234'
              value: Slide like a lizard
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Static API key supplied by Proton at integration onboarding.