DM Champ Docs

API de tratos

Un trato es una oportunidad de venta en su tablero de Sales Pipeline: un título, un valor, la etapa en la que se encuentra y, opcionalmente, el contacto al que pertenece y el miembro del equipo al que está asignado. Esta guía cubre la lectura y gestión de tratos a través de la API.

Todos los ejemplos a continuación muestran la forma de consulta ?apiKey= en cURL y el encabezado X-API-Key en JavaScript y Python; cualquiera de los dos funciona en todos los endpoints.

El objeto de trato 

{
  "id": "deal_abc123",
  "title": "Annual plan – Jane's Clinic",
  "description": "Asked for pricing on the annual plan.",
  "company": "Jane's Clinic",
  "stage": "stage-2",
  "value": 4800,
  "probability": 60,
  "priority": "high",
  "status": "open",
  "source": "whatsapp",
  "position": 0,
  "contact_id": "ctc_9f8e7d",
  "assigned_to": "usr_4a2b",
  "tags": ["clinic"],
  "close_date": "2026-10-01T00:00:00.000Z",
  "created_at": "2026-09-05T09:12:00.000Z",
  "updated_at": "2026-09-05T09:40:00.000Z",
  "stage_entered_at": "2026-09-05T09:40:00.000Z"
}

stage es el id de una de las etapas de su pipeline; léalos desde la configuración de su pipeline (GET /users/me/pipeline-settings). Las marcas de tiempo están en formato ISO 8601.

Listar tratos

GET /deals — devuelve los tratos de su cuenta, empezando por el más reciente.

Parámetros de consulta (todos opcionales): stage (un id de etapa), contact_id, limit (predeterminado 50, máximo 200), cursor (desde el next_cursor de la página anterior).

cURL

curl "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY&stage=stage-2&limit=50"

JavaScript

const res = await fetch("https://api.dmchamp.com/v1/deals?stage=stage-2&limit=50", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const { deals, next_cursor } = await res.json();

Python

res = requests.get(
    "https://api.dmchamp.com/v1/deals",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"stage": "stage-2", "limit": 50},
)
deals = res.json()["deals"]

Respuesta (200)

{ "success": true, "deals": [{ "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." }], "next_cursor": null }

Obtener un trato

GET /deals/{dealId}

curl "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"

Respuesta (200)

{ "success": true, "deal": { "id": "deal_abc123", "title": "Annual plan – Jane's Clinic", "...": "..." } }

Un trato que no existe, o que pertenece a otra cuenta, devuelve 404.

Crear un trato

POST /deals — title y stage son obligatorios; stage debe ser uno de los ids de etapa de su pipeline.

curl -X POST "https://api.dmchamp.com/v1/deals?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Annual plan – Jane'"'"'s Clinic", "stage": "stage-1", "value": 4800, "contact_id": "ctc_9f8e7d" }'

Respuesta (201)

{ "success": true, "deal_id": "deal_abc123" }

Actualizar un trato

PUT /deals/{dealId} — envíe solo los campos que desea cambiar (title, description, value, stage, status, priority, contact_id, …). value debe ser un número.

curl -X PUT "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "value": 5200, "priority": "high" }'

Respuesta (200): { "success": true, "deal_id": "deal_abc123" }

Mover un trato a otra etapa

POST /deals/{dealId}/move — cuerpo { "new_stage_id": "stage-3", "new_position": 0 }. La posición 0 coloca la tarjeta en la parte superior de la columna.

curl -X POST "https://api.dmchamp.com/v1/deals/deal_abc123/move?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "new_stage_id": "stage-3", "new_position": 0 }'

Respuesta (200): { "success": true, "deal_id": "deal_abc123", "stage": "stage-3", "position": 0 }

Eliminar un trato

DELETE /deals/{dealId} — elimina el trato. Esto no se puede deshacer.

curl -X DELETE "https://api.dmchamp.com/v1/deals/deal_abc123?apiKey=YOUR_API_KEY"

Respuesta (200): { "success": true }

Próximos pasos

  • Embudo de ventas — cómo funcionan las etapas, las etiquetas de etapa y el tablero.
  • API de tareas — las tareas se pueden vincular a un trato con deal_id.
  • Automatizaciones — los pasos Buscar tratos y Buscar trato leen los mismos datos dentro de un flujo de trabajo.