CRM

Create an opportunity

Puts a lead into the pipeline.

Tool

filmo_crm_opportunities_create

Writecrm:write

crm:write
120/min
May need an add-on

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_crm_opportunities_create",
    "arguments": {
      "name": "Example"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "opportunityId": "oppo_8f2a1c",
      "identifier": "<identifier>",
      "name": "Example",
      "status": "open",
      "amount": "1234.50",
      "currency": "EUR",
      "pipelineId": "pipe_8f2a1c",
      "pipelineName": "Example",
      "stageId": "stag_8f2a1c",
      "stageName": "Example",
      "stageType": "open",
      "effectiveProbability": 1,
      "weightedAmount": "1234.50",
      "daysInStage": 1,
      "expectedCloseDate": "2026-09-01T08:00:00Z",
      "contactName": "Example",
      "companyName": "Example",
      "ownerName": "Example",
      "source": "inbound_email",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z",
      "description": "<description>",
      "version": 1,
      "collaboratorStaffIds": [
        "coll_8f2a1c"
      ],
      "quoteIds": [
        "quot_8f2a1c"
      ],
      "stageHistory": [
        {
          "fromStageId": "from_8f2a1c",
          "toStageId": "tost_8f2a1c",
          "toStatus": "<toStatus>",
          "daysInPrevStage": 1,
          "movedAt": "2026-09-01T08:00:00Z",
          "note": "<note>"
        }
      ]
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

If you omit pipelineId it uses the default pipeline of the account, and if you omit stageId the first stage of that pipeline. The amount goes as a decimal string so as not to lose cents to floating-point rounding. Returns the created opportunity with its effective probability and its weighted amount.

Arguments

namestringRequired

Short name of the opportunity.

Limits: min length 1, max length 200

descriptionstring

Free-text description.

pipelineIdstring

Pipeline. If omitted, the default pipeline of the account.

stageIdstring

Initial stage. If omitted, the first stage of the pipeline.

amountstring

Amount as a decimal string, with at most two decimals. E.g.: "12500.00".

Limits: pattern ^\d+(\.\d{1,2})?$

currencystring

Uppercase ISO 4217 code. E.g.: "EUR".

Limits: pattern ^[A-Z]{3}$

probabilityOverrideinteger

Own probability, as a percentage. If omitted, it inherits the probability of the stage.

Limits: min 0, max 100

expectedCloseDatestring<date-time>

Expected close date, in ISO 8601 with offset.

contactIdstring

Contact (person) of the opportunity.

companyIdstring

Contact (company) of the opportunity.

ownerStaffIdstring

Sales owner.

projectIdstring

Associated project.

sourcestring

Lead source channel: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner or other.

Available options: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

sourceDetailstring

Free-text detail of the source channel.

Limits: max length 200

utmCampaignstring

Attribution campaign.

Limits: max length 200

utmSourcestring

Attribution source.

Limits: max length 200

utmMediumstring

Attribution medium.

Limits: max length 200

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

opportunityIdstring

identifierstring

namestring

statusstring

Available options: open, won, lost

amountstring

currencystring

pipelineIdstring

pipelineNamestring

stageIdstring

stageNamestring

stageTypestring

Available options: open, won, lost

effectiveProbabilitynumber

weightedAmountstring

daysInStageinteger

expectedCloseDatestring<date-time>

contactNamestring

companyNamestring

ownerNamestring

sourcestring

Available options: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

createdAtstring<date-time>

updatedAtstring<date-time>

descriptionstring

versioninteger

Limits: min 1

collaboratorStaffIdsstring[]

quoteIdsstring[]

stageHistoryobject[]

Show child attributes

stageHistory.fromStageIdstring

stageHistory.toStageIdstring

stageHistory.toStatusstring

stageHistory.daysInPrevStageinteger

stageHistory.movedAtstring<date-time>

stageHistory.notestring

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs POST /api/v1/crm/opportunities.

CRM
Create an opportunity
Puts a lead into the pipeline.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Create an opportunity

Safe writes

Errors