CRM

Oportunidad

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

Esquemas: OpportunityDto, OpportunityDetailDto

{
  "opportunityId": "string",
  "identifier": "string",
  "name": "Example",
  "status": "open",
  "amount": "1234.50",
  "currency": "EUR",
  "pipelineId": "string",
  "pipelineName": "Example",
  "stageId": "string",
  "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": "string",
  "version": 1,
  "collaboratorStaffIds": [
    "string"
  ],
  "quoteIds": [
    "string"
  ],
  "stageHistory": [
    {
      "fromStageId": "string",
      "toStageId": "string",
      "toStatus": "string",
      "daysInPrevStage": 1,
      "movedAt": "2026-09-01T08:00:00Z",
      "note": "string"
    }
  ]
}

Generado a partir del esquema

Una oportunidad de venta del CRM: en qué embudo y etapa está, por cuánto, con quién y con qué probabilidad. Necesita el add-on de CRM: sin él la respuesta es 402 addon_required. Las escrituras usan bloqueo optimista: envía la version que leíste. La lectura de detalle, GET /api/v1/crm/opportunities/{opportunityId}, añade la descripción, los colaboradores, los presupuestos vinculados, la versión y, con includeHistory=true, el historial de etapas.

Atributos

opportunityIdstring

identifierstring

namestring

statusstring

Opciones disponibles: open, won, lost

amountstring

currencystring

pipelineIdstring

pipelineNamestring

stageIdstring

stageNamestring

stageTypestring

Opciones disponibles: open, won, lost

effectiveProbabilitynumber

weightedAmountstring

daysInStageinteger

expectedCloseDatestring<date-time>

contactNamestring

companyNamestring

ownerNamestring

sourcestring

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

createdAtstring<date-time>

updatedAtstring<date-time>

descriptionstringsolo en el detalle

versionintegersolo en el detalle

Límites: mín. 1

collaboratorStaffIdsstring[]solo en el detalle

quoteIdsstring[]solo en el detalle

stageHistoryobject[]solo en el detalle

Mostrar atributos hijos

stageHistory.fromStageIdstring

stageHistory.toStageIdstring

stageHistory.toStatusstring

stageHistory.daysInPrevStageinteger

stageHistory.movedAtstring<date-time>

stageHistory.notestring

Valores

status: open, won, lost
stageType: open, won, lost
source: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

Lo devuelven

GET /api/v1/crm/opportunities — Listar oportunidades
GET /api/v1/crm/opportunities/{opportunityId} — Obtener una oportunidad

Lo modifican

POST /api/v1/crm/opportunities — Crear una oportunidad
PATCH /api/v1/crm/opportunities/{opportunityId} — Actualizar una oportunidad
PATCH /api/v1/crm/opportunities/{opportunityId}/stage — Mover una oportunidad a otra etapa
POST /api/v1/crm/opportunities/{opportunityId}/close — Cerrar una oportunidad
POST /api/v1/crm/opportunities/{opportunityId}/links — Vincular un documento a una oportunidad

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican