Create Opportunity

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEghl.create_opportunity

• Contract tier: agent_ready
• Risk: write
• Catalog version: 2026-07-12.2
• Descriptor hash: 4ac37f3715bf19413d3a1bde540aabecf43ca350c0411479c84245fc66abd3b0

Create a new opportunity in GoHighLevel CRM GHL category: Opportunities. This writes to GoHighLevel and may change account data.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-create-opportunity-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.create_opportunity",
    "arguments": {
      "name": "name_example",
      "pipelineId": "pipelineId_123",
      "contactId": "contactId_123",
      "dryRun": false,
      "status": "open",
      "tenantId": "tenantId_123",
      "assignedTo": "assignedTo_example",
      "customFields": [],
      "monetaryValue": 1,
      "pipelineStageId": "pipelineStageId_123"
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "name",
    "pipelineId",
    "contactId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name/title of the opportunity"
    },
    "dryRun": {
      "type": "boolean",
      "default": false,
      "description": "Preview changes without writing"
    },
    "status": {
      "enum": [
        "open",
        "won",
        "lost",
        "abandoned"
      ],
      "type": "string",
      "default": "open",
      "description": "Initial status of the opportunity (default: open)"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    },
    "contactId": {
      "type": "string",
      "description": "ID of the contact associated with this opportunity"
    },
    "assignedTo": {
      "type": "string",
      "description": "User ID to assign this opportunity to"
    },
    "pipelineId": {
      "type": "string",
      "description": "ID of the pipeline this opportunity belongs to"
    },
    "customFields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "field_value"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "GHL custom field ID."
          },
          "field_value": {
            "description": "Value to set for the custom field."
          }
        }
      },
      "description": "Optional opportunity custom field values using GHL custom field IDs."
    },
    "monetaryValue": {
      "type": "number",
      "description": "Monetary value of the opportunity in dollars"
    },
    "pipelineStageId": {
      "type": "string",
      "description": "Optional pipeline stage ID. Use resolve_stage first when targeting a specific stage; if omitted, GHL assigns its default stage."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-create-opportunity-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.create_opportunity",
    "arguments": {
      "name": "name_example",
      "pipelineId": "pipelineId_123",
      "contactId": "contactId_123",
      "dryRun": false,
      "status": "open",
      "tenantId": "tenantId_123",
      "assignedTo": "assignedTo_example",
      "customFields": [],
      "monetaryValue": 1,
      "pipelineStageId": "pipelineStageId_123"
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-create-opportunity-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.create_opportunity",
    "arguments": {
      "name": "name_example",
      "pipelineId": "pipelineId_123",
      "contactId": "contactId_123",
      "dryRun": false,
      "status": "open",
      "tenantId": "tenantId_123",
      "assignedTo": "assignedTo_example",
      "customFields": [],
      "monetaryValue": 1,
      "pipelineStageId": "pipelineStageId_123"
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-create-opportunity-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.create_opportunity",
    "arguments": {
      "name": "name_example",
      "pipelineId": "pipelineId_123",
      "contactId": "contactId_123",
      "dryRun": false,
      "status": "open",
      "tenantId": "tenantId_123",
      "assignedTo": "assignedTo_example",
      "customFields": [],
      "monetaryValue": 1,
      "pipelineStageId": "pipelineStageId_123"
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.create_opportunity executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}