Servers Playground How we check Add a server Log in

Pipeline CRM MCP by usefulapi

Working · 683 ms

io.usefulapi/pipeline-crmv1.8.0 Domain verified

Manage Pipeline CRM deals, people, companies, notes and calendar entries.

Sales & CRM

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://pipeline-crm.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

pipelinecrm_add_note Destructive

WRITE: log a note (activity) on a deal, person or company. Pass at least one of deal_id, person_id, company_id. POST /notes.

contentstring, required

The note text.

titlestring

Optional note title.

deal_idinteger

Attach to this deal.

person_idinteger

Attach to this person.

company_idinteger

Attach to this company.

note_category_idinteger

Note category id (see pipelinecrm_list_lookup with kind note_categories).

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Pipeline CRM MCP by usefulapi MCP server | mcptry

Pipeline CRM MCP by usefulapi

Working · 683 ms

io.usefulapi/pipeline-crmv1.8.0 Domain verified

Manage Pipeline CRM deals, people, companies, notes and calendar entries.

Sales & CRM

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://pipeline-crm.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

pipelinecrm_add_note Destructive

WRITE: log a note (activity) on a deal, person or company. Pass at least one of deal_id, person_id, company_id. POST /notes.

contentstring, required

The note text.

titlestring

Optional note title.

deal_idinteger

Attach to this deal.

person_idinteger

Attach to this person.

company_idinteger

Attach to this company.

note_category_idinteger

Note category id (see pipelinecrm_list_lookup with kind note_categories).

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Tools (30)

pipelinecrm_add_note

WRITE: log a note (activity) on a deal, person or company. Pass at least one of deal_id, person_id, company_id. POST /notes.

destructive

Argument	Type	Description
title	string	Optional note title.
content*	string	The note text.
deal_id	integer	Attach to this deal.
person_id	integer	Attach to this person.
company_id	integer	Attach to this company.
note_category_id	integer	Note category id (see pipelinecrm_list_lookup with kind note_categories).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "content"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Optional note title."
    },
    "content": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "The note text."
    },
    "deal_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Attach to this deal.",
      "exclusiveMinimum": 0
    },
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Attach to this person.",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Attach to this company.",
      "exclusiveMinimum": 0
    },
    "note_category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Note category id (see pipelinecrm_list_lookup with kind note_categories).",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_create_calendar_entry

WRITE: create a task (CalendarTask, optional due date) or an event (CalendarEvent, start_time and end_time required), optionally tied to a deal, person or company. POST /calendar_entries.

destructive

Argument	Type	Description
name*	string	Title of the task or event.
type*	string	CalendarTask or CalendarEvent.
all_day	boolean	All-day entry (events default to false, tasks to true).
due_date	string	Tasks only: the due date (yyyy-mm-dd).
end_time	string	Events only: end time.
start_time	string	Events only: start time.
category_id*	integer	Event category id (required by Pipeline CRM; see pipelinecrm_list_lookup with kind event_categories).
description	string	Details.
association_id

pipelinecrm_create_company

WRITE: create a company. POST /companies.

destructive

Argument	Type	Description
web	string	Website.
city	string	City.
name*	string	Company name.
email	string	Company email address.
state	string	State or province.
phone1	string	Primary business phone.
country	string	Country.
tag_ids	array	Full list of company tag ids.
owner_id	integer	Owner user id.
address_1	string	Address line 1.
address_2	string

pipelinecrm_create_deal

WRITE: create a deal. Give the owner (user id), stage id, value, expected close date and company or primary contact when known; a new company is created from company_name if no company_id is given. No email is sent to the owner. POST /deals.

destructive

Argument	Type	Description
name*	string	Deal name.
value	any	The deal's value in its currency.
summary	string	Description of the deal.
tag_ids	array	Deal tag ids.
owner_id	integer	User id of the owner (default: the authenticated user).
stage_id	integer	Deal stage id (see pipelinecrm_list_deal_stages).
source_id	integer	Lead source id (see pipelinecrm_list_lookup with kind lead_sources).
company_id	integer	Existing company id.
person_ids	array	Ids of the people associated with the deal.

pipelinecrm_create_person

WRITE: create a lead or contact. Pass at least a first or last name or an email. No email is sent to the owner. POST /people.

destructive

Argument	Type	Description
type	string	Lead or Contact (default: the account's default).
email	string	Work email address.
phone	string	Work phone.
mobile	string	Mobile phone.
summary	string	Notes about the person.
tag_ids	array	Full list of contact tag ids.
owner_id	integer	Owner user id.
position	string	Job title.
last_name	string	Last name.
company_id	integer	Existing company id.

pipelinecrm_deal_totals_by_stage

Count and total value of the deals visible to the user in every deal stage: the pipeline summary. GET /deals/totals_by_stage.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

pipelinecrm_get_calendar_entry

One calendar entry (task or event) by id. GET /calendar_entries/{id}.

read-only

Argument	Type	Description
calendar_entry_id*	integer	Pipeline CRM calendar entry id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "calendar_entry_id"
  ],
  "properties": {
    "calendar_entry_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM calendar entry id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_get_company

One company by id with address, phones, website, owner, tags and custom fields. GET /companies/{id}.

read-only

Argument	Type	Description
company_id*	integer	Pipeline CRM company id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_id"
  ],
  "properties": {
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM company id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_get_deal

One deal by id with owner, company, people, stage, status, loss/won reasons, tags, custom fields and the next task. GET /deals/{id}.

read-only

Argument	Type	Description
deal_id*	integer	Pipeline CRM deal id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "deal_id"
  ],
  "properties": {
    "deal_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM deal id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_get_note

One note (activity) by id with its content, author, category, associations and comments. GET /notes/{id}.

read-only

Argument	Type	Description
note_id*	integer	Pipeline CRM note id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "note_id"
  ],
  "properties": {
    "note_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM note id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_get_person

One person (lead or contact) by id with all contact details, company, owner, tags and custom fields. GET /people/{id}.

read-only

Argument	Type	Description
person_id*	integer	Pipeline CRM person id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "person_id"
  ],
  "properties": {
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM person id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_get_profile

The Pipeline CRM user this credential acts as: id, name and whether they are an account admin. The user's api_key is never returned. GET /profile.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

pipelinecrm_get_user

One user of the account by id. The user's api_key is never returned. GET /users/{id}.

read-only

Argument	Type	Description
user_id*	integer	Pipeline CRM user id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM user id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_calendar_entries

List calendar entries: tasks (a due date) and events (a start and end time) tied to deals, people or companies. Filter by kind, owner, a date range, and completed, incomplete or late. GET /calendar_entries.

read-only

Argument	Type	Description
kind	string	Only tasks or only events.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
status	string	Only incomplete, completed or late (overdue) entries.
to_date	string	Only entries on or before this date (yyyy-mm-dd).
owner_id	integer	Only entries owned by this user id.
per_page	integer	Results per page, 1-200 (default 25).
from_date	string	Only entries on or after this date (yyyy-mm-dd).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "kind": {
      "enum": [
        "task",
        "event"
      ],
      "type": "string",
      "description": "Only tasks or only events."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "status": {
      "enum": [
        "incomplete",
        "completed",
        "late"
      ],
      "type": "string",
      "description": "Only incomplete, completed or late (overdue) entries."
    },
    "to_date": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only entries on or before this date (yyyy-mm-dd)."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only entries owned by this user id.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "from_date": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Only entries on or after this date (yyyy-mm-dd)."
    }
  }
}

pipelinecrm_list_companies

List or search companies with address, website, phones, owner, tags and pipeline totals. GET /companies.

read-only

Argument	Type	Description
city	string	Companies in this city.
name	string	Companies whose name starts with this text.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>.
country	string	Companies in this country.
tag_ids	array	Only companies with these tag ids.
owner_id	integer	Only companies owned by this user id.
per_page	integer	Results per page, 1-200 (default 25).
is_customer	boolean	true = customers only, false = non-customers only.

pipelinecrm_list_company_people

List the people (leads and contacts) who work at one company. GET /companies/{id}/people.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).
company_id*	integer	Pipeline CRM company id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM company id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_deal_notes

List the notes (activities) logged on one deal, with author, category and content. GET /deals/{id}/notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
deal_id*	integer	Pipeline CRM deal id.
per_page	integer	Results per page, 1-200 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "deal_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "deal_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM deal id.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_deal_pipelines

List the deal pipelines (each has its own stages) with id, name and which one is the default. GET /admin/deal_pipelines.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_deal_stages

List the deal stages with id, name, default win probability and the pipeline each belongs to. Use the ids to filter or move deals. GET /admin/deal_stages.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_deals

List or search deals with stage, owner, company, primary contact, value, probability and expected close date. Filter by name, stage, pipeline, status, owner, company, contact, archived flag, value range and created, expected-close, closed or modified dates. Money values come back as decimal strings. GET /deals.

read-only

Argument	Type	Description
name	string	Deals whose name contains this text.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>.
archived	boolean	true = archived deals only, false = not archived only.
owner_id	integer	Only deals owned by this user id.
per_page	integer	Results per page, 1-200 (default 25).
stage_id	integer	Only deals in this deal stage id (see pipelinecrm_list_deal_stages).
max_value	number

pipelinecrm_list_lookup

List one set of account lookup values to get ids for filters and writes. kind: deal_statuses, deal_loss_reasons, deal_won_reasons, deal_tags, lead_statuses, lead_sources, contact_tags, company_tags, note_categories, event_categories, task_priorities, task_statuses, teams. GET /admin/<kind>.

read-only

Argument	Type	Description
kind*	string	Which lookup list to return.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "kind"
  ],
  "properties": {
    "kind": {
      "enum": [
        "deal_statuses",
        "deal_loss_reasons",
        "deal_won_reasons",
        "deal_tags",
        "lead_statuses",
        "lead_sources",
        "contact_tags",
        "company_tags",
        "note_categories",
        "event_categories",
        "task_priorities",
        "task_statuses",
        "teams"
      ],
      "type": "string",
      "description": "Which lookup list to return."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_notes

List notes (called activities in the Pipeline CRM app) attached to a deal, person or company. Pass at least one of deal_id, person_id, company_id. Filter by text, category, author and created date. GET /notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>.
query	string	Free-text search across title, content, category and comments.
deal_id	integer	Notes on this deal.
per_page	integer	Results per page, 1-200 (default 25).
author_id	integer	Only notes written by this user id.
person_id	integer	Notes on this person.
company_id	integer	Notes on this company.
category_id

pipelinecrm_list_people

List or search people (leads and contacts) with email, phones, position, company, owner, lead status and tags. Use search for a quick match on name, email or company name, or filter precisely. GET /people.

read-only

Argument	Type	Description
name	string	Matches the first or last name.
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>.
type	string	Only leads or only contacts.
email	string	Matches the work email address.
search	string	Matches first name, last name, email or company name.
tag_ids	array	Only people with these tag ids.
owner_id	integer	Only people owned by this user id.
per_page	integer

pipelinecrm_list_person_deals

List the deals one person is associated with. GET /people/{id}/deals.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).
person_id*	integer	Pipeline CRM person id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "person_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM person id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_person_notes

List the notes (activities) logged on one person. GET /people/{id}/notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-200 (default 25).
person_id*	integer	Pipeline CRM person id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "person_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM person id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_list_users

List the users of the Pipeline CRM account (id, name, email, team, admin flag). Use the ids as owners of deals, people and companies. api_key values are never returned. GET /users.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
email	string	Only users with this email address.
per_page	integer	Results per page, 1-200 (default 25).
including_inactive	boolean	Also return deactivated users.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "email": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only users with this email address."
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "including_inactive": {
      "type": "boolean",
      "description": "Also return deactivated users."
    }
  }
}

pipelinecrm_update_calendar_entry

WRITE: change a task or event; only the fields you pass change. Pass complete: true to mark a task done. PUT /calendar_entries/{id}.

destructive

Argument	Type	Description
name	string	New title.
complete	boolean	true marks the entry complete, false reopens it.
due_date	string	Tasks only: new due date (yyyy-mm-dd).
end_time	string	Events only: new end time.
start_time	string	Events only: new start time.
category_id	integer	New event category id.
description	string	New details.
calendar_entry_id*	integer	Pipeline CRM calendar entry id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "calendar_entry_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New title."
    },
    "complete": {
      "type": "boolean",
      "description": "true marks the entry complete, false reopens it."
    },
    "due_date": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Tasks only: new due date (yyyy-mm-dd)."
    },
    "end_time": {
      "type": "string",
      "description": "Events only: new end time."
    },
    "start_time": {
      "type": "string",
      "description": "Events only: new start time."
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New event category id.",
      "exclusiveMinimum": 0
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "New details."
    },
    "calendar_entry_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM calendar entry id.",
      "exclusiveMinimum": 0
    }
  }
}

pipelinecrm_update_company

WRITE: change fields of a company; only the fields you pass change. PUT /companies/{id}.

destructive

Argument	Type	Description
web	string	Website.
city	string	City.
name	string	New company name.
email	string	Company email address.
state	string	State or province.
phone1	string	Primary business phone.
country	string	Country.
tag_ids	array	Full list of company tag ids.
owner_id	integer	Owner user id.
address_1	string	Address line 1.
address_2	string

pipelinecrm_update_deal

WRITE: change fields of a deal; only the fields you pass change. Move it to another stage with stage_id. Setting probability to 100 or 0 closes the deal as won or lost; give won/loss reason ids when you do. Archive with archived: true. No email is sent to a new owner. PUT /deals/{id}.

destructive

Argument	Type	Description
name	string	New deal name.
value	any	New value.
deal_id*	integer	Pipeline CRM deal id.
summary	string	New description.
tag_ids	array	Full list of deal tag ids (replaces the list).
archived	boolean	true archives the deal, false restores it.
owner_id	integer	New owner user id.
stage_id	integer	Move the deal to this deal stage id.
status_id	integer	Deal status id.

pipelinecrm_update_person

WRITE: change fields of a person; only the fields you pass change. Pass type Contact to convert a lead. PUT /people/{id}.

destructive

Argument	Type	Description
type	string	Convert the record to a Lead or a Contact.
email	string	Work email address.
phone	string	Work phone.
mobile	string	Mobile phone.
summary	string	Notes about the person.
tag_ids	array	Full list of contact tag ids.
owner_id	integer	Owner user id.
position	string	Job title.
last_name	string	Last name.
person_id*	integer	Pipeline CRM person id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "web": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Website."
    },
    "city": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "City."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Company name."
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Company email address."
    },
    "state": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "State or province."
    },
    "phone1": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Primary business phone."
    },
    "country": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Country."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of company tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Owner user id.",
      "exclusiveMinimum": 0
    },
    "address_1": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Address line 1."
    },
    "address_2": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Address line 2."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description."
    },
    "postal_code": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Postal code."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Deal name."
    },
    "value": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "string",
          "pattern": "^-?\\d{1,15}(\\.\\d{1,4})?$"
        }
      ],
      "description": "The deal's value in its currency."
    },
    "summary": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "Description of the deal."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Deal tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "User id of the owner (default: the authenticated user).",
      "exclusiveMinimum": 0
    },
    "stage_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Deal stage id (see pipelinecrm_list_deal_stages).",
      "exclusiveMinimum": 0
    },
    "source_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Lead source id (see pipelinecrm_list_lookup with kind lead_sources).",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing company id.",
      "exclusiveMinimum": 0
    },
    "person_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Ids of the people associated with the deal."
    },
    "company_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Creates a new company with this name for the deal."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    },
    "primary_contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing person id of the primary contact.",
      "exclusiveMinimum": 0
    },
    "expected_close_date": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Expected close date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "type": {
      "enum": [
        "Lead",
        "Contact"
      ],
      "type": "string",
      "description": "Lead or Contact (default: the account's default)."
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Work email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Work phone."
    },
    "mobile": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Mobile phone."
    },
    "summary": {
      "type": "string",
      "maxLength": 5000,
      "description": "Notes about the person."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of contact tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Owner user id.",
      "exclusiveMinimum": 0
    },
    "position": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Job title."
    },
    "last_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Last name."
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing company id.",
      "exclusiveMinimum": 0
    },
    "first_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "First name."
    },
    "company_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Links the company with this name, creating it when none matches."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    },
    "lead_source_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Lead source id.",
      "exclusiveMinimum": 0
    },
    "lead_status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Lead status id.",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "city": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Companies in this city."
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Companies whose name starts with this text."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z0-9_]{1,60}(,-?[a-z0-9_]{1,60}){0,4}$",
      "description": "Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>."
    },
    "country": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Companies in this country."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Only companies with these tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only companies owned by this user id.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "is_customer": {
      "type": "boolean",
      "description": "true = customers only, false = non-customers only."
    },
    "created_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or after this date (yyyy-mm-dd)."
    },
    "created_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or before this date (yyyy-mm-dd)."
    },
    "modified_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Modified on or after this date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Deals whose name contains this text."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z0-9_]{1,60}(,-?[a-z0-9_]{1,60}){0,4}$",
      "description": "Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>."
    },
    "archived": {
      "type": "boolean",
      "description": "true = archived deals only, false = not archived only."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only deals owned by this user id.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "stage_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only deals in this deal stage id (see pipelinecrm_list_deal_stages).",
      "exclusiveMinimum": 0
    },
    "max_value": {
      "type": "number",
      "description": "Only deals worth at most this much."
    },
    "min_value": {
      "type": "number",
      "description": "Only deals worth at least this much."
    },
    "status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only deals with this deal status id (open, won, lost... see pipelinecrm_list_lookup with kind deal_statuses).",
      "exclusiveMinimum": 0
    },
    "pipeline_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only deals in this deal pipeline id (see pipelinecrm_list_deal_pipelines).",
      "exclusiveMinimum": 0
    },
    "closed_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Closed (won or lost) on or after this date (yyyy-mm-dd)."
    },
    "company_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only deals whose company name contains this text."
    },
    "closed_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Closed (won or lost) on or before this date (yyyy-mm-dd)."
    },
    "created_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or after this date (yyyy-mm-dd)."
    },
    "created_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or before this date (yyyy-mm-dd)."
    },
    "modified_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Modified on or after this date (yyyy-mm-dd)."
    },
    "primary_contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only deals whose primary contact is this person id.",
      "exclusiveMinimum": 0
    },
    "expected_close_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Expected to close on or after this date (yyyy-mm-dd)."
    },
    "expected_close_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Expected to close on or before this date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z0-9_]{1,60}(,-?[a-z0-9_]{1,60}){0,4}$",
      "description": "Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>."
    },
    "query": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Free-text search across title, content, category and comments."
    },
    "deal_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Notes on this deal.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "author_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only notes written by this user id.",
      "exclusiveMinimum": 0
    },
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Notes on this person.",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Notes on this company.",
      "exclusiveMinimum": 0
    },
    "category_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only notes in this note category id (see pipelinecrm_list_lookup with kind note_categories).",
      "exclusiveMinimum": 0
    },
    "created_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or after this date (yyyy-mm-dd)."
    },
    "created_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or before this date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Matches the first or last name."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z0-9_]{1,60}(,-?[a-z0-9_]{1,60}){0,4}$",
      "description": "Sort column key, with a leading - for descending; several keys separated by commas. Example: -deal_value,deal_name. Custom fields sort as custom_label_<id>."
    },
    "type": {
      "enum": [
        "Lead",
        "Contact"
      ],
      "type": "string",
      "description": "Only leads or only contacts."
    },
    "email": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Matches the work email address."
    },
    "search": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Matches first name, last name, email or company name."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 50,
      "minItems": 1,
      "description": "Only people with these tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only people owned by this user id.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 25).",
      "exclusiveMinimum": 0
    },
    "source_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only people with this lead source id.",
      "exclusiveMinimum": 0
    },
    "status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only people with this lead status id (see pipelinecrm_list_lookup with kind lead_statuses).",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only people at this company id.",
      "exclusiveMinimum": 0
    },
    "company_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only people whose company name contains this text."
    },
    "created_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or after this date (yyyy-mm-dd)."
    },
    "created_before": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Created on or before this date (yyyy-mm-dd)."
    },
    "modified_after": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Modified on or after this date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_id"
  ],
  "properties": {
    "web": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Website."
    },
    "city": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "City."
    },
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New company name."
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Company email address."
    },
    "state": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "State or province."
    },
    "phone1": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Primary business phone."
    },
    "country": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Country."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of company tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Owner user id.",
      "exclusiveMinimum": 0
    },
    "address_1": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Address line 1."
    },
    "address_2": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Address line 2."
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM company id.",
      "exclusiveMinimum": 0
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description."
    },
    "postal_code": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Postal code."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "deal_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New deal name."
    },
    "value": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "string",
          "pattern": "^-?\\d{1,15}(\\.\\d{1,4})?$"
        }
      ],
      "description": "New value."
    },
    "deal_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM deal id.",
      "exclusiveMinimum": 0
    },
    "summary": {
      "type": "string",
      "maxLength": 5000,
      "description": "New description."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of deal tag ids (replaces the list)."
    },
    "archived": {
      "type": "boolean",
      "description": "true archives the deal, false restores it."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "New owner user id.",
      "exclusiveMinimum": 0
    },
    "stage_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Move the deal to this deal stage id.",
      "exclusiveMinimum": 0
    },
    "status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Deal status id.",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Company id.",
      "exclusiveMinimum": 0
    },
    "person_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of associated person ids (replaces the list)."
    },
    "closed_time": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "Actual close date (yyyy-mm-dd)."
    },
    "probability": {
      "type": "integer",
      "maximum": 100,
      "minimum": 0,
      "description": "Probability of closing, 0-100. 100 closes the deal as won, 0 as lost."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    },
    "won_reason_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Deal won reason id.",
      "exclusiveMinimum": 0
    },
    "loss_reason_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Deal loss reason id.",
      "exclusiveMinimum": 0
    },
    "won_reason_notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "Why the deal was won."
    },
    "loss_reason_notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "Why the deal was lost."
    },
    "primary_contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Primary contact person id.",
      "exclusiveMinimum": 0
    },
    "expected_close_date": {
      "type": "string",
      "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
      "description": "New expected close date (yyyy-mm-dd)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "person_id"
  ],
  "properties": {
    "type": {
      "enum": [
        "Lead",
        "Contact"
      ],
      "type": "string",
      "description": "Convert the record to a Lead or a Contact."
    },
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Work email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Work phone."
    },
    "mobile": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Mobile phone."
    },
    "summary": {
      "type": "string",
      "maxLength": 5000,
      "description": "Notes about the person."
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "type": "integer",
        "maximum": 9007199254740991,
        "exclusiveMinimum": 0
      },
      "maxItems": 100,
      "description": "Full list of contact tag ids."
    },
    "owner_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Owner user id.",
      "exclusiveMinimum": 0
    },
    "position": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Job title."
    },
    "last_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Last name."
    },
    "person_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Pipeline CRM person id.",
      "exclusiveMinimum": 0
    },
    "company_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing company id.",
      "exclusiveMinimum": 0
    },
    "first_name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "First name."
    },
    "company_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Links the company with this name, creating it when none matches."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field values keyed by the custom field's key (see the account's custom field labels in Pipeline CRM).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_]{1,80}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "string",
                  "maxLength": 500
                },
                {
                  "type": "number"
                }
              ]
            },
            "maxItems": 100
          }
        ]
      }
    },
    "lead_source_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Lead source id.",
      "exclusiveMinimum": 0
    },
    "lead_status_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Lead status id.",
      "exclusiveMinimum": 0
    }
  }
}