*REST API › Endpoint reference › CRM*

# Update an opportunity

> Updates an opportunity (send only the fields to change).

`version` is REQUIRED: copy it from the previous read. If someone moved it between your read and your write, the request is rejected instead of overwriting their change. To move stage or close, use their own endpoints.

`PATCH /api/v1/crm/opportunities/{opportunityId}` — scope `crm:write`

Scope: `crm:write` · 120/min · Strict tenancy · Add-on (402) · Idempotency-Key · If-Match · MCP: `filmo_crm_opportunities_update`

## Authorizations

Bearer API key with the scope below. `crm:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |
| `If-Match` | string | No | Optimistic locking: the `ETag` you read from the resource (or `*`). If the resource changed since, the write is rejected with `412 precondition_failed` before doing anything; read it again and retry. Without the header the write always proceeds. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `opportunityId` | string | Yes | Opportunity identifier. |

## Body

Body schema: `OpportunityUpdateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | Short name. |
| `description` | string | No | Free-text description. |
| `amount` | string | No | Amount as a decimal string, with at most two decimals. E.g.: "12500.00". |
| `currency` | string | No | Uppercase ISO 4217 code. E.g.: "EUR". |
| `probabilityOverride` | integer | No | Own probability, as a percentage. |
| `expectedCloseDate` | string<date-time> | No | Expected close date, in ISO 8601 with offset. |
| `contactId` | string | No | Contact (person). |
| `companyId` | string | No | Contact (company). |
| `ownerStaffId` | string | No | Sales owner. |
| `source` | string | No | Lead source channel: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner or other. `inbound_email`, `website_form`, `referral`, `cold_outreach`, `event`, `social`, `existing_customer`, `partner`, `other` |
| `sourceDetail` | string | No | Free-text detail of the channel. |

## Request examples

*Update an opportunity*

**cURL**

```bash
curl https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "13800.00",
  "expectedCloseDate": "2026-10-22T00:00:00+02:00"
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '13800.00',
    expectedCloseDate: '2026-10-22T00:00:00+02:00'
  })
})
```

**Python**

```python
import uuid
import requests

requests.patch(
    "https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "amount": "13800.00",
      "expectedCloseDate": "2026-10-22T00:00:00+02:00"
    }
)
```

## Response

Response schema: `OpportunityDetailDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on required (addon_required): the account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | Precondition failed (precondition_failed): the `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Full detail of a CRM opportunity. |
| `data.opportunityId` | string |  |
| `data.identifier` | string |  |
| `data.name` | string |  |
| `data.status` | string |  `open`, `won`, `lost` |
| `data.amount` | string |  |
| `data.currency` | string |  |
| `data.pipelineId` | string |  |
| `data.pipelineName` | string |  |
| `data.stageId` | string |  |
| `data.stageName` | string |  |
| `data.stageType` | string |  `open`, `won`, `lost` |
| `data.effectiveProbability` | number |  |
| `data.weightedAmount` | string |  |
| `data.daysInStage` | integer |  |
| `data.expectedCloseDate` | string<date-time> |  |
| `data.contactName` | string |  |
| `data.companyName` | string |  |
| `data.ownerName` | string |  |
| `data.source` | string |  `inbound_email`, `website_form`, `referral`, `cold_outreach`, `event`, `social`, `existing_customer`, `partner`, `other` |
| `data.createdAt` | string<date-time> |  |
| `data.updatedAt` | string<date-time> |  |
| `data.description` | string |  |
| `data.version` | integer |  |
| `data.collaboratorStaffIds` | string[] |  |
| `data.quoteIds` | string[] |  |
| `data.stageHistory` | object[] |  |
| `data.stageHistory.fromStageId` | string |  |
| `data.stageHistory.toStageId` | string |  |
| `data.stageHistory.toStatus` | string |  |
| `data.stageHistory.daysInPrevStage` | integer |  |
| `data.stageHistory.movedAt` | string<date-time> |  |
| `data.stageHistory.note` | string |  |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "opportunityId": "opportunity_9f3a2b",
    "identifier": "Example identifier",
    "name": "Example opportunity",
    "status": "open",
    "amount": "120.00",
    "currency": "EUR",
    "pipelineId": "pipeline_9f3a2b",
    "pipelineName": "Example pipeline name",
    "stageId": "stage_9f3a2b",
    "stageName": "Example stage name",
    "stageType": "open",
    "effectiveProbability": 1,
    "weightedAmount": "120.00",
    "daysInStage": 1,
    "expectedCloseDate": "2026-09-01T10:00:00+02:00",
    "contactName": "Example contact name",
    "companyName": "Example company name",
    "ownerName": "Example owner name",
    "source": "inbound_email",
    "createdAt": "2026-09-01T10:00:00+02:00",
    "updatedAt": "2026-09-01T10:00:00+02:00",
    "description": "Example text.",
    "version": 1,
    "collaboratorStaffIds": [
      "collaborator_staff_9f3a2b"
    ],
    "quoteIds": [
      "quote_9f3a2b"
    ],
    "stageHistory": [
      {
        "fromStageId": "from_stage_9f3a2b",
        "toStageId": "to_stage_9f3a2b",
        "toStatus": "Example to status",
        "daysInPrevStage": 1,
        "movedAt": "2026-09-01T10:00:00+02:00",
        "note": "Example text."
      }
    ]
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | `precondition_failed` | The `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/crm/update-an-opportunity  
Last updated: 2026-10-25