Actualizar negocio

PATCHhttps://api.bydomu.com/v1/deals/{id}

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Actualiza solo los campos enviados. Para cambiar de etapa usa POST /deals/{id}/move.

Permission
deals:write
Keys
Secret only (server-side)

Headers

X-API-Keystringrequired
Your secret key.
Idempotency-Keystring
Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 chars

Path parameters

idstringrequired
ID del negocio

Body (JSON)

titlestring
3–200 chars
valuenumber
≥ 0 · nullable
currencystring
COPUSDEURMXNBRLARSBOBCADCLPCRCCUPDOPGBPGTQHNLNIOPENPYGUYUVES · default="COP"
probabilityinteger
default=0 · 0–100 · nullable
expectedCloseDatestring
nullable
notesstring
≤ 5000 chars
contactIdstring
nullable
stageIdstring
pipelineIdstring
agentIdstring
propertyIdsstring[]
intentstring
PURCHASERENTBOTHSELLER
budgetMinnumber
≥ 0 · nullable
budgetMaxnumber
≥ 0 · nullable
preferredZonesstring[]
propertyTypesstring[]
leadSourcestring
REFERRALPORTALSOCIALCOLDOTHER
commissionConfigIdstring
nullable

Responses

200Negocio actualizado
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
402PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
404NOT_FOUND · El recurso no existe en la organización.
409DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl -X PATCH "https://api.bydomu.com/v1/deals/clx1deal001" \
  -H "X-API-Key: $BYDOMU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "value": 340000000,
  "probability": 65
}'
JavaScript
const res = await fetch("https://api.bydomu.com/v1/deals/clx1deal001", {
  method: "PATCH",
  headers: {
    "X-API-Key": process.env.BYDOMU_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "value": 340000000,
    "probability": 65
  }),
});
const data = await res.json();
Python
import os, requests

r = requests.patch(
    "https://api.bydomu.com/v1/deals/clx1deal001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]},
    json={
        "value": 340000000,
        "probability": 65
    }
)
data = r.json()
Response · 200 · example
{
  "data": {
    "id": "clx1deal001",
    "code": "N-0031",
    "title": "Venta Apto Chapinero - María González",
    "value": "350000000.00",
    "currency": "COP",
    "probability": 40,
    "status": "OPEN",
    "closedAt": "2026-10-30T18:00:00.000Z",
    "expectedCloseDate": "2026-11-30T00:00:00.000Z",
    "lostReason": "Compró con otra inmobiliaria",
    "lostReasonCategory": "COMPETENCIA",
    "intent": "PURCHASE",
    "budgetMin": "300000000.00",
    "budgetMax": "400000000.00",
    "preferredZones": [
      "Chapinero"
    ],
    "propertyTypes": [
      "APARTMENT"
    ],
    "leadSource": "REFERRAL",
    "notes": "Pre-aprobada para crédito hipotecario.",
    "agentId": "clx1usr001",
    "contactId": "clx1con001",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-25T16:45:00.000Z",
    "contact": {
      "id": "clx1con001",
      "firstName": "María",
      "lastName": "González",
      "phone": "+573001234567",
      "email": "[email protected]",
      "source": "WHATSAPP",
      "score": 75,
      "budget": "350000000.00"
    },
    "agent": {
      "id": "clx1usr001",
      "firstName": "Carlos",
      "lastName": "Rodríguez"
    },
    "placements": [
  …

The key goes in the BYDOMU_API_KEY variable. The example data belongs to no agency.