CRM

Cerrar una oportunidad

Cierra la oportunidad como ganada o perdida.

POST

/api/v1/crm/opportunities/{opportunityId}/close

curl https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c/close \
  --request POST \
  --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 '{
  "outcome": "lost",
  "lostReason": "lost_to_competitor"
}'

Node.jsfetch('https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c/close', { method: 'POST', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ outcome: 'lost', lostReason: 'lost_to_competitor' }) })Pythonimport uuid import requests requests.post( "https://app.filmo.io/api/v1/crm/opportunities/oppo_8f2a1c/close", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "outcome": "lost", "lostReason": "lost_to_competitor" } )

{
  "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."
      }
    ]
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "crm"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "crm:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generado a partir del esquema

Si omites toStageId pasa a la primera etapa del tipo correspondiente del embudo. Al perderla, el motivo va ESTRUCTURADO (lostReason): es lo que permite analizar el embudo después.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. crm:write

Cabeceras

Idempotency-Keystring

Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 validation_error, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera Idempotent-Replay: true. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

opportunityIdstringObligatorio

Identificador de la oportunidad.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: OpportunityCloseBody

outcomestringObligatorio

Resultado del cierre.

Opciones disponibles: won, lost

toStageIdstring

Fase de destino. Si se omite, la primera fase del tipo correspondiente.

wonReasonstring

Motivo, cuando el resultado es "won".

Límites: longitud máx. 500

lostReasonstring

Motivo estructurado, cuando el resultado es "lost".

Opciones disponibles: price, timing, no_budget, no_decision, lost_to_competitor, no_response, duplicate, other

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: OpportunityDetailDto

Sobre: OpportunityDetailResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Detalle completo de una oportunidad del CRM.

Mostrar atributos hijos

data.opportunityIdstring

data.identifierstring

data.namestring

data.statusstring

Opciones disponibles: open, won, lost

data.amountstring

data.currencystring

data.pipelineIdstring

data.pipelineNamestring

data.stageIdstring

data.stageNamestring

data.stageTypestring

Opciones disponibles: open, won, lost

data.effectiveProbabilitynumber

data.weightedAmountstring

data.daysInStageinteger

data.expectedCloseDatestring<date-time>

data.contactNamestring

data.companyNamestring

data.ownerNamestring

data.sourcestring

Opciones disponibles: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

data.descriptionstring

data.versioninteger

Límites: mín. 1

data.collaboratorStaffIdsstring[]

data.quoteIdsstring[]

data.stageHistoryobject[]

Mostrar atributos hijos

data.stageHistory.fromStageIdstring

data.stageHistory.toStageIdstring

data.stageHistory.toStatusstring

data.stageHistory.daysInPrevStageinteger

data.stageHistory.movedAtstring<date-time>

data.stageHistory.notestring

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos

meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos

meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

meta.warnings.linkstring

Dónde está documentada la deprecación (el changelog).

Errores

Estado	Códigos	Significado
400	`validation_error`	Consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable.
402	`addon_required`	El plan de la cuenta no incluye el add-on que necesita esta operación; `requiredAddon` lo nombra.
404	`not_found`	No existe o queda fuera del alcance de la clave de API.
409	`conflict`	El estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (`If-Match`) retuvo el recurso durante más de cinco segundos. `errors[0].code` indica cuál: `in_progress` y `lock_timeout` se resuelven reintentando; `invalid_state` no, porque el estado del recurso prohíbe la operación.
412	`precondition_failed`	La etiqueta de entidad `If-Match` no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422	`idempotency_key_reused`	La misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

CRM
Oportunidad
Oportunidad del CRM: en qué embudo y etapa está, por cuánto, con quién y con qué probabilidad.

¿Te ha resultado útil esta página?

Ejemplos de petición

Autorizaciones

Cabeceras

Parámetros de ruta

Cuerpo

Respuesta

Errores

Obsolescencia

Relacionado

Páginas relacionadas

Oportunidad