Live Direct Marketing Companies / Custom Fields API

The Companies / Custom Fields API from Live Direct Marketing — 4 operation(s) for companies / custom fields.

Documentation GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/companies/custom-fields List company, contact or lead custom fields · List custom field definitions for the given entity (company/contact/lead) #

Ask an LLM

“Which custom fields are defined on companies?”

“Can I list the custom field definitions for contacts or leads too?”

Tell an agent

List custom field definitions for entity {entity}.

Show the {entity} custom field setup.

POST /api/companies/custom-fields Create a company custom field · Create a custom field definition #

Ask an LLM

“How do I add a new custom field to company records?”

“Can a company custom field be a dropdown with fixed options?”

Tell an agent

Create a {fieldType} company field labelled {label} with slug {slug}.

Add a {fieldType} field {label} (slug {slug}) with options {options}.

PUT /api/companies/custom-fields/reorder Reorder company custom fields · Reorder custom field definitions by id array #

Ask an LLM

“How do I change the order company custom fields appear in?”

“Can I reorder company fields by passing their ids?”

Tell an agent

Reorder the company custom field definitions.

Set a new display order for company custom fields.

GET /api/companies/custom-fields/{companyId}/values Get a company's custom field values · Get custom field values for a company #

Ask an LLM

“What custom field values are filled in for a particular company?”

“Can I read all custom data stored on one company?”

Tell an agent

Get custom field values for company {companyId}.

Show company {companyId}'s custom data.

POST /api/companies/custom-fields/{companyId}/values Set a company's custom field values · Set custom field values for a company #

Ask an LLM

“How do I fill in several custom fields on a company at once?”

“Can I note the source of custom values I write to a company?”

Tell an agent

Set company {companyId}'s custom values to {values}.

Save custom values {values} on company {companyId} from source {source}.

PUT /api/companies/custom-fields/{id} Update a company custom field definition · Update a custom field definition #

Ask an LLM

“How do I change the label or options of a company custom field?”

“Can I make an existing company field filterable or required?”

Tell an agent

Relabel company custom field {id} as {label}.

Update the options of company field {id} to {options}.

DELETE /api/companies/custom-fields/{id} Delete a company custom field definition · Delete a custom field definition (requires confirm=true) #

Ask an LLM

“How do I delete a company custom field?”

“Why does deleting a company field need an explicit confirmation?”

Tell an agent destructive · confirm first

Delete company custom field {id} with confirm={confirm}.

Remove company field definition {id}, confirm {confirm}.

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/live-direct-marketing-online:live-direct-marketing-online-companies-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

openapi: 3.2.0
info:
  title: LDM v3 Companies / Custom Fields API
  description: 'Multi-tenant B2B outreach automation platform. Auth: JWT Bearer (15-min) or tenant API key (ldm_*) managed in CRM Settings → API Keys. All tenant-scoped endpoints require the X-Tenant-Id header.'
  version: 1.0.0
  contact: {}
servers:
- url: https://api.live-direct-marketing.online
  description: Production
- url: https://api.dev.live-direct-marketing.online
  description: Development
- url: http://127.0.0.1:3000
  description: Local
tags:
- name: Companies / Custom Fields
paths:
  /api/companies/custom-fields:
    get:
      operationId: CompanyCustomFieldController_getDefinitions
      parameters:
      - name: entity
        required: true
        in: query
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: List custom field definitions for the given entity (company/contact/lead)
      tags:
      - Companies / Custom Fields
    post:
      operationId: CompanyCustomFieldController_createDefinition
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomFieldDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Create a custom field definition
      tags:
      - Companies / Custom Fields
  /api/companies/custom-fields/reorder:
    put:
      operationId: CompanyCustomFieldController_reorder
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Reorder custom field definitions by id array
      tags:
      - Companies / Custom Fields
      x-required-scope:
      - crm:write
  /api/companies/custom-fields/{companyId}/values:
    get:
      operationId: CompanyCustomFieldController_getValues
      parameters:
      - name: companyId
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Get custom field values for a company
      tags:
      - Companies / Custom Fields
    post:
      operationId: CompanyCustomFieldController_setValues
      parameters:
      - name: companyId
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetValuesDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Set custom field values for a company
      tags:
      - Companies / Custom Fields
  /api/companies/custom-fields/{id}:
    put:
      operationId: CompanyCustomFieldController_updateDefinition
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomFieldDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a custom field definition
      tags:
      - Companies / Custom Fields
    delete:
      operationId: CompanyCustomFieldController_deleteDefinition
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: confirm
        required: true
        in: query
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Delete a custom field definition (requires confirm=true)
      tags:
      - Companies / Custom Fields
components:
  schemas:
    CreateCustomFieldDto:
      type: object
      properties:
        entity:
          type: string
          default: company
        slug:
          type: string
          pattern: /^[a-z0-9_]+$/
        label:
          type: string
        labelEn:
          type: string
        fieldType:
          type: string
        options:
          type: array
          items:
            type: object
        isRequired:
          type: boolean
        isVisibleInTable:
          type: boolean
        isFilterable:
          type: boolean
        isSortable:
          type: boolean
        numberFormat:
          type: object
        group:
          type: string
        settings:
          type: object
      required:
      - slug
      - label
      - fieldType
    UpdateCustomFieldDto:
      type: object
      properties:
        label:
          type: string
        labelEn:
          type: string
        options:
          type: array
          items:
            type: object
        isRequired:
          type: boolean
        isVisibleInTable:
          type: boolean
        isFilterable:
          type: boolean
        isSortable:
          type: boolean
        numberFormat:
          type: object
        group:
          type: string
        sortOrder:
          type: number
    SetValuesDto:
      type: object
      properties:
        values:
          type: object
        source:
          type: string
      required:
      - values
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT access token from /auth/login (Bearer <token>)
    tenant-api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Tenant API key (Bearer ldm_*) for MCP/A2A clients. Issued via CRM Settings → API Keys.
    rpa-service:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Dedicated RPA service key. No tenant API-key or query-key authentication.

Live Direct Marketing Companies / Custom Fields API

Operations 7

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification