CRM

Crear una oportunidad

Pone un lead en el embudo.

POST
/api/v1/crm/opportunities

Ejemplos de petición

curl https://app.filmo.io/api/v1/crm/opportunities \
  --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 '{
  "name": "Spot de otoño — Producciones Delta",
  "amount": "12500.00",
  "currency": "EUR",
  "expectedCloseDate": "2026-10-15T00:00:00+02:00",
  "contactId": "cont_8f2a1c",
  "source": "website_form",
  "utmCampaign": "otono-2026"
}'
{
  "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."
      }
    ]
  }
}

Generado a partir del esquema

Si omites pipelineId, usa el embudo por defecto de la cuenta, y si omites stageId, la primera etapa de ese embudo. El importe va como cadena decimal para no perder céntimos por el redondeo de coma flotante. Devuelve la oportunidad creada con su probabilidad efectiva y su importe ponderado.

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\""

Cuerpo

application/json

Esquema del cuerpo: OpportunityCreateBody

namestringObligatorio

Nombre corto de la oportunidad.

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

descriptionstring

Descripción en texto libre.

pipelineIdstring

Embudo. Si se omite, el embudo por defecto de la cuenta.

stageIdstring

Etapa inicial. Si se omite, la primera etapa del embudo.

amountstring

Importe como cadena decimal, con un máximo de dos decimales. P. ej.: "12500.00".

Límites: patrón ^\d+(\.\d{1,2})?$

currencystring

Código ISO 4217 en mayúsculas. Ej.: "EUR".

Límites: patrón ^[A-Z]{3}$

probabilityOverrideinteger

Probabilidad propia, como porcentaje. Si se omite, hereda la probabilidad de la etapa.

Límites: mín. 0, máx. 100

expectedCloseDatestring<date-time>

Fecha de cierre prevista, en ISO 8601 con desplazamiento.

contactIdstring

Contacto (persona) de la oportunidad.

companyIdstring

Contacto (empresa) de la oportunidad.

ownerStaffIdstring

Responsable comercial.

projectIdstring

Proyecto asociado.

sourcestring

Canal de origen del lead: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner u other.

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

sourceDetailstring

Detalle en texto libre del canal de origen.

Límites: longitud máx. 200

utmCampaignstring

Campaña de atribución.

Límites: longitud máx. 200

utmSourcestring

Fuente de atribución.

Límites: longitud máx. 200

utmMediumstring

Medio de atribución.

Límites: longitud máx. 200

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.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
402addon_requiredEl plan de la cuenta no incluye el add-on que necesita esta operación; requiredAddon lo nombra.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl 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.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
422idempotency_key_reusedLa 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.