Read Revamp CRM contacts, deals, notes and orders; create and update contacts, deals and notes.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
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.
WRITE: add a note to a contact or a deal timeline in Revamp CRM. It is an internal note: nothing is sent to the contact. Adding twice creates two notes. POST /Notes/{Contact|Deal}/{id}/Add.
The note text.
The contact id or deal id.
What the note is attached to.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: add a note to a contact or a deal timeline in Revamp CRM. It is an internal note: nothing is sent to the contact. Adding twice creates two notes. POST /Notes/{Contact|Deal}/{id}/Add.
| Argument | Type | Description |
|---|---|---|
| text* | string | The note text. |
| entity_id* | string | The contact id or deal id. |
| entity_type* | string | What the note is attached to. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_type",
"entity_id",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"description": "The note text."
},
"entity_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "The contact id or deal id."
},
"entity_type": {
"enum": [
"Contact",
"Deal"
],
"type": "string",
"description": "What the note is attached to."
}
}
}How many orders Revamp CRM has synced for one store. GET /Orders/Count/{provider}/{store}.
| Argument | Type | Description |
|---|---|---|
| store* | string | Store name / domain as Revamp CRM stores it. |
| provider* | string | Store provider, e.g. "Shopify". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"provider",
"store"
],
"properties": {
"store": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Store name / domain as Revamp CRM stores it."
},
"provider": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Store provider, e.g. \"Shopify\"."
}
}
}WRITE: create a new contact (person or organization) in the Revamp CRM account. It does not email or message the contact. Search first (revampcrm_list_contacts with keyword/email) so you do not create a duplicate: this tool does not check. Returns Revamp CRM's import result (status, message, the new id in ImportingIntoId). POST /Contacts/New.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| name* | string | Full name of the contact (or of the organization). |
| tags | string | Tags, comma separated. On an update this REPLACES the contact's tags. |
| state | string | |
| title | string | Job title. |
| gender | string | |
| country | string | Country as Revamp CRM stores it (code or name; see an existing contact). |
| website | string | |
| subscribed | string | Marketing email subscription state. |
| description |
WRITE: create a new deal (opportunity) in the Revamp CRM account, optionally linked to a contact. It does not message anyone. Use revampcrm_list_deals_by_stage (CurrentStages) for valid stage names and revampcrm_list_deal_currencies for currencies. POST /Deals.
| Argument | Type | Description |
|---|---|---|
| name* | string | Deal name. |
| note | string | Note stored with the deal. |
| tags | string | Tags, comma separated. |
| value* | number | Deal value in `currency` (required by Revamp CRM). |
| status | string | Deal status as existing deals show it (see revampcrm_list_deals). Default "Open". |
| product | string | |
| currency | string | Currency, e.g. USD. |
| pipeline | string | Pipeline name (default pipeline if omitted). |
| contact_id | string | Contact the deal belongs to. |
| deal_stage |
One contact by id with full details: contact info, address, tags, stage, custom fields, owner, previous/next task, deal totals (won/lost/open per currency), e-commerce order summary and order details. GET /Contacts/GetSingleContact/{id}/true.
| Argument | Type | Description |
|---|---|---|
| contact_id* | string | Revamp CRM contact id (_id from revampcrm_list_contacts). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM contact id (_id from revampcrm_list_contacts)."
}
}
}The Revamp CRM user the credentials belong to: id, name, email and role. Use the id as owner_user_id / assigned_user_id. GET /User/WhoAmI.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}One note or timeline entry by id: text/message, type, author, related contact and deal, created date. GET /Notes/getNote/{id}.
| Argument | Type | Description |
|---|---|---|
| note_id* | string | Revamp CRM note id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"note_id"
],
"properties": {
"note_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM note id."
}
}
}One synced e-commerce order (Shopify, WooCommerce, BigCommerce ...) by the store's own order id: totals, tax, discount, shipping, financial and shipping status, line items and customer. Needs the provider name and store name exactly as Revamp CRM stores them (see ExternalProviders / Shop on a contact). GET /Orders/Get/{provider}/{store}/{id}.
| Argument | Type | Description |
|---|---|---|
| store* | string | Store name / domain as Revamp CRM stores it. |
| order_id* | string | The order id in the store. |
| provider* | string | Store provider, e.g. "Shopify". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"provider",
"store",
"order_id"
],
"properties": {
"store": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Store name / domain as Revamp CRM stores it."
},
"order_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The order id in the store."
},
"provider": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Store provider, e.g. \"Shopify\"."
}
}
}All deals of one contact (name, stage, status, value, currency, expected closing date, owner). GET /Contacts/{id}/Deals.
| Argument | Type | Description |
|---|---|---|
| contact_id* | string | Revamp CRM contact id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM contact id."
}
}
}The contact (lead) stage names configured in the account, in order. Use them as contact_stage filters and values. GET /Account/ContactStage.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Search and list contacts (people and organizations), newest filters first. With no filter it lists all contacts. Each item has name, organization, email/phone (ContactInfo), tags, stage, owner, last-contacted info and e-commerce order summary. resultsInfo carries totalCount and hasNext/nextIndex: pass nextIndex as `page` for the next page. GET /Contacts.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| page | integer | Page index as in the previous reply's resultsInfo.nextIndex (default: the first page). |
| tags | string | Only contacts with this tag. |
| string | Only contacts with this email value. | |
| phone | string | Only contacts with this phone number. |
| state | string | |
| gender | string | |
| country | string | |
| keyword | string | Free-text search (name, email, organization ...). |
The contact custom fields defined in the account: CustomFieldName (the property name, e.g. CustomField3), DisplayName, Type and list options. Read this to interpret CustomFieldN values on contacts and to set them. GET /Account/getAccountCustomFields.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}The currencies that deals in this account can use (name, value, symbol). GET /Account/DealCurrencies.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List deals with optional filters (status, pipeline, owner, contact, currency, created / expected-closing / closed date ranges). Each deal has name, stage, status, value, probability, forecasted sale, expected closing date, contact, owner and tags. The deal endpoints have no paging: the reply is cut to `limit` and says how many matched. GET /Deals/List.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Show at most this many deals, 1-200 (default 50). The reply says how many matched in total. |
| status | string | Deal status filter as existing deals show it, e.g. "Open", "Won" or "Lost". |
| sort_by | string | Field to sort by (e.g. Value, CreatedOn, ExpectedClosureDate). |
| currency | string | Currency, e.g. USD (see revampcrm_list_deal_currencies). |
| pipeline | string | Pipeline name. |
| closed_to | string | Closed (won/lost) on or before this date. |
| contact_id | string | Only deals of this contact. |
| created_to | string | Created on or before this date. |
The deal pipeline board: deals grouped by stage (with the stage names in CurrentStages). Same filters as revampcrm_list_deals. At most `limit` deals are shown per stage. GET /Deals/ByStage.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Show at most this many deals per stage, 1-200 (default 50). |
| status | string | Deal status filter as existing deals show it, e.g. "Open", "Won" or "Lost". |
| sort_by | string | Field to sort by (e.g. Value, CreatedOn, ExpectedClosureDate). |
| currency | string | Currency, e.g. USD (see revampcrm_list_deal_currencies). |
| pipeline | string | Pipeline name. |
| closed_to | string | Closed (won/lost) on or before this date. |
| contact_id | string | Only deals of this contact. |
| created_to | string | Created on or before this date. |
| closed_from | string |
WRITE: mark a deal as Lost in Revamp CRM with a reason (its status changes and it counts in lost-deal reports). It does not message the contact. Check the deal first with revampcrm_search_deals. POST /Deals/Lost.
| Argument | Type | Description |
|---|---|---|
| note | string | Optional note stored with the change. |
| reason* | string | Why the deal was lost. |
| deal_id* | string | Revamp CRM deal id (_id or DealId of a deal). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deal_id",
"reason"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Optional note stored with the change."
},
"reason": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Why the deal was lost."
},
"deal_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM deal id (_id or DealId of a deal)."
}
}
}WRITE: mark a deal as Won in Revamp CRM (its status changes and it counts in won-deal reports). It does not message the contact. Check the deal first with revampcrm_search_deals. POST /Deals/Won.
| Argument | Type | Description |
|---|---|---|
| note | string | Optional note stored with the change. |
| deal_id* | string | Revamp CRM deal id (_id or DealId of a deal). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deal_id"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Optional note stored with the change."
},
"deal_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM deal id (_id or DealId of a deal)."
}
}
}Search deals by name, status, stage, contact, owner, pipeline, product, sales region or deal source (text match as Revamp CRM defines it). Revamp CRM applies `limit` itself and gives no total: may_have_more is true when a full page came back. GET /Deals/Search.
| Argument | Type | Description |
|---|---|---|
| name | string | Deal name (contains). |
| limit | integer | Show at most this many deals, 1-200 (default 50). The reply says how many matched in total. |
| value | string | Deal value. |
| status | string | e.g. "Open", "Won", "Lost". |
| contact | string | Contact name. |
| product | string | |
| sort_by | string | |
| pipeline | string | |
| deal_stage | string | |
| owner_name | string |
WRITE: change fields of an existing contact. Only the fields you pass change: the tool reads the stored contact first and sends it back with your changes (Revamp CRM's update replaces the whole record). `tags` replaces the contact's tags; passing a field overwrites its old value. It does not email or message the contact. PUT /Contacts/Edit.
| Argument | Type | Description |
|---|---|---|
| city | string | |
| name | string | Full name of the contact (or of the organization). |
| tags | string | Tags, comma separated. On an update this REPLACES the contact's tags. |
| state | string | |
| title | string | Job title. |
| gender | string | |
| country | string | Country as Revamp CRM stores it (code or name; see an existing contact). |
| website | string | |
| contact_id* | string | Revamp CRM contact id to update. |
| string |
| About / description text. |
| postal_code | string |
| contact_type | string | Contact type as Revamp CRM names it (see an existing contact). |
| organization | string | Company name. |
| address_line1 | string |
| address_line2 | string |
| contact_stage | string | A contact stage name (see revampcrm_list_contact_stages). |
| custom_fields | object | Custom fields by Revamp property name, e.g. {"CustomField1": "Gold", "CustomField101": 42}. revampcrm_list_custom_fields explains what each one means. |
| primary_email | string |
| primary_phone | string |
| contact_source | string |
| secondary_email | string |
| secondary_phone | string |
| assigned_user_id | string | Id of the Revamp CRM user who owns the contact (revampcrm_get_current_user returns your own). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name of the contact (or of the organization)."
},
"tags": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Tags, comma separated. On an update this REPLACES the contact's tags."
},
"state": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Job title."
},
"gender": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"country": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Country as Revamp CRM stores it (code or name; see an existing contact)."
},
"website": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"subscribed": {
"enum": [
"UNSUBSCRIBED",
"MARKETING_OFF",
"MARKETING_ON"
],
"type": "string",
"description": "Marketing email subscription state."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "About / description text."
},
"postal_code": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"contact_type": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Contact type as Revamp CRM names it (see an existing contact)."
},
"organization": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company name."
},
"address_line1": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"address_line2": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"contact_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A contact stage name (see revampcrm_list_contact_stages)."
},
"custom_fields": {
"type": "object",
"description": "Custom fields by Revamp property name, e.g. {\"CustomField1\": \"Gold\", \"CustomField101\": 42}. revampcrm_list_custom_fields explains what each one means.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
}
]
}
},
"primary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254
},
"primary_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"contact_source": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"secondary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254
},
"secondary_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"assigned_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Id of the Revamp CRM user who owns the contact (revampcrm_get_current_user returns your own)."
}
}
}| string |
| Stage name in the pipeline (required by Revamp CRM; see revampcrm_list_deals_by_stage CurrentStages). |
| deal_source | string |
| probability | number | Win probability in percent. |
| sales_region | string |
| owner_user_id | string | Revamp CRM user id of the deal owner. |
| expected_close_date | string | Expected closing date, e.g. 2026-12-31. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"value",
"deal_stage"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Deal name."
},
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Note stored with the deal."
},
"tags": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Tags, comma separated."
},
"value": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Deal value in `currency` (required by Revamp CRM)."
},
"status": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Deal status as existing deals show it (see revampcrm_list_deals). Default \"Open\"."
},
"product": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"currency": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Currency, e.g. USD."
},
"pipeline": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Pipeline name (default pipeline if omitted)."
},
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Contact the deal belongs to."
},
"deal_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Stage name in the pipeline (required by Revamp CRM; see revampcrm_list_deals_by_stage CurrentStages)."
},
"deal_source": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"probability": {
"type": "number",
"maximum": 100,
"minimum": 0,
"description": "Win probability in percent."
},
"sales_region": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"owner_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM user id of the deal owner."
},
"expected_close_date": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Expected closing date, e.g. 2026-12-31."
}
}
}| sort_by | string | Field to sort by (e.g. name, createdon, updatedon). |
| added_to | string | Created on or before this date. |
| pagesize | integer | Contacts per page, 1-100 (default 25). |
| has_deals | boolean | true = only contacts with deals. |
| added_from | string | Created on or after this date. |
| deal_stage | string | Only contacts that have a deal in this stage. |
| subscribed | integer | Subscription filter as Revamp CRM numbers it. |
| is_customer | boolean | true = only customers (contacts with orders). |
| contact_type | string |
| contact_stage | string | Only contacts in this stage (see revampcrm_list_contact_stages). |
| contact_source | string |
| sort_direction | string |
| assigned_user_id | string | Only contacts owned by this user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"page": {
"type": "integer",
"maximum": 100000,
"minimum": 0,
"description": "Page index as in the previous reply's resultsInfo.nextIndex (default: the first page)."
},
"tags": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only contacts with this tag."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 1,
"description": "Only contacts with this email value."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Only contacts with this phone number."
},
"state": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"gender": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"country": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"keyword": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Free-text search (name, email, organization ...)."
},
"sort_by": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Field to sort by (e.g. name, createdon, updatedon)."
},
"added_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or before this date."
},
"pagesize": {
"type": "integer",
"maximum": 100,
"description": "Contacts per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"has_deals": {
"type": "boolean",
"description": "true = only contacts with deals."
},
"added_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or after this date."
},
"deal_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Only contacts that have a deal in this stage."
},
"subscribed": {
"type": "integer",
"maximum": 5,
"minimum": 0,
"description": "Subscription filter as Revamp CRM numbers it."
},
"is_customer": {
"type": "boolean",
"description": "true = only customers (contacts with orders)."
},
"contact_type": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"contact_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Only contacts in this stage (see revampcrm_list_contact_stages)."
},
"contact_source": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"assigned_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only contacts owned by this user id."
}
}
}| closed_from | string | Closed (won/lost) on or after this date. |
| created_from | string | Created on or after this date. |
| owner_user_id | string | Only deals owned by this Revamp CRM user id. |
| sort_direction | string |
| expected_close_to | string | Expected closing date on or before this date. |
| expected_close_from | string | Expected closing date on or after this date. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"description": "Show at most this many deals, 1-200 (default 50). The reply says how many matched in total.",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Deal status filter as existing deals show it, e.g. \"Open\", \"Won\" or \"Lost\"."
},
"sort_by": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Field to sort by (e.g. Value, CreatedOn, ExpectedClosureDate)."
},
"currency": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Currency, e.g. USD (see revampcrm_list_deal_currencies)."
},
"pipeline": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Pipeline name."
},
"closed_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Closed (won/lost) on or before this date."
},
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only deals of this contact."
},
"created_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or before this date."
},
"closed_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Closed (won/lost) on or after this date."
},
"created_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or after this date."
},
"owner_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only deals owned by this Revamp CRM user id."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"expected_close_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Expected closing date on or before this date."
},
"expected_close_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Expected closing date on or after this date."
}
}
}| Closed (won/lost) on or after this date. |
| created_from | string | Created on or after this date. |
| owner_user_id | string | Only deals owned by this Revamp CRM user id. |
| sort_direction | string |
| expected_close_to | string | Expected closing date on or before this date. |
| expected_close_from | string | Expected closing date on or after this date. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"description": "Show at most this many deals per stage, 1-200 (default 50).",
"exclusiveMinimum": 0
},
"status": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Deal status filter as existing deals show it, e.g. \"Open\", \"Won\" or \"Lost\"."
},
"sort_by": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Field to sort by (e.g. Value, CreatedOn, ExpectedClosureDate)."
},
"currency": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "Currency, e.g. USD (see revampcrm_list_deal_currencies)."
},
"pipeline": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Pipeline name."
},
"closed_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Closed (won/lost) on or before this date."
},
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only deals of this contact."
},
"created_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or before this date."
},
"closed_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Closed (won/lost) on or after this date."
},
"created_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Created on or after this date."
},
"owner_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only deals owned by this Revamp CRM user id."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"expected_close_to": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Expected closing date on or before this date."
},
"expected_close_from": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Expected closing date on or after this date."
}
}
}| Name of the deal owner. |
| deal_source | string |
| sales_region | string |
| sort_direction | string |
| expected_close_date | string | A date as Revamp CRM accepts it, e.g. 2026-10-31. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Deal name (contains)."
},
"limit": {
"type": "integer",
"maximum": 200,
"description": "Show at most this many deals, 1-200 (default 50). The reply says how many matched in total.",
"exclusiveMinimum": 0
},
"value": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Deal value."
},
"status": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "e.g. \"Open\", \"Won\", \"Lost\"."
},
"contact": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Contact name."
},
"product": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"sort_by": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"pipeline": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"deal_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"owner_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Name of the deal owner."
},
"deal_source": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"sales_region": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"expected_close_date": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "A date as Revamp CRM accepts it, e.g. 2026-10-31."
}
}
}| subscribed | string | Marketing email subscription state. |
| description | string | About / description text. |
| postal_code | string |
| contact_type | string | Contact type as Revamp CRM names it (see an existing contact). |
| organization | string | Company name. |
| address_line1 | string |
| address_line2 | string |
| contact_stage | string | A contact stage name (see revampcrm_list_contact_stages). |
| custom_fields | object | Custom fields by Revamp property name, e.g. {"CustomField1": "Gold", "CustomField101": 42}. revampcrm_list_custom_fields explains what each one means. |
| primary_email | string |
| primary_phone | string |
| contact_source | string |
| secondary_email | string |
| secondary_phone | string |
| assigned_user_id | string | Id of the Revamp CRM user who owns the contact (revampcrm_get_current_user returns your own). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Full name of the contact (or of the organization)."
},
"tags": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Tags, comma separated. On an update this REPLACES the contact's tags."
},
"state": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Job title."
},
"gender": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"country": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Country as Revamp CRM stores it (code or name; see an existing contact)."
},
"website": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Revamp CRM contact id to update."
},
"subscribed": {
"enum": [
"UNSUBSCRIBED",
"MARKETING_OFF",
"MARKETING_ON"
],
"type": "string",
"description": "Marketing email subscription state."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "About / description text."
},
"postal_code": {
"type": "string",
"maxLength": 30,
"minLength": 1
},
"contact_type": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Contact type as Revamp CRM names it (see an existing contact)."
},
"organization": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company name."
},
"address_line1": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"address_line2": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"contact_stage": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A contact stage name (see revampcrm_list_contact_stages)."
},
"custom_fields": {
"type": "object",
"description": "Custom fields by Revamp property name, e.g. {\"CustomField1\": \"Gold\", \"CustomField101\": 42}. revampcrm_list_custom_fields explains what each one means.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 1000
},
{
"type": "number"
}
]
}
},
"primary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254
},
"primary_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"contact_source": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"secondary_email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254
},
"secondary_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"assigned_user_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Id of the Revamp CRM user who owns the contact (revampcrm_get_current_user returns your own)."
}
}
}