Crear nota

POSThttps://api.bydomu.com/v1/notes

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Crea una nota rápida, suelta o enganchada a un contacto, una propiedad o un negocio, con recordatorio opcional. Respeta el tope de notas del plan (403 PLAN_LIMIT_REACHED).

Permissão
notes:write
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.
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

Corpo (JSON)

bodystringobrigatório
≤ 5000 chars
contactIdstring
propertyIdstring
dealIdstring
capturedInobject
remindAtstring
date-time

Respostas

201Nota creada
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 POST "https://api.bydomu.com/v1/notes" \
  -H "X-API-Key: $BYDOMU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Llamó: quiere ver el apartamento el sábado en la mañana.",
  "contactId": "clx1con001",
  "remindAt": "2026-10-03T13:00:00.000Z"
}'
JavaScript
const res = await fetch("https://api.bydomu.com/v1/notes", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.BYDOMU_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "body": "Llamó: quiere ver el apartamento el sábado en la mañana.",
    "contactId": "clx1con001",
    "remindAt": "2026-10-03T13:00:00.000Z"
  }),
});
const data = await res.json();
Python
import os, requests

r = requests.post(
    "https://api.bydomu.com/v1/notes",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]},
    json={
        "body": "Llamó: quiere ver el apartamento el sábado en la mañana.",
        "contactId": "clx1con001",
        "remindAt": "2026-10-03T13:00:00.000Z"
    }
)
data = r.json()
Resposta · 201 · exemplo
{
  "data": {
    "id": "clx1not001",
    "body": "Llamó: quiere ver el apartamento el sábado en la mañana.",
    "pinned": false,
    "contactId": "clx1con001",
    "propertyId": "clx1prop001",
    "dealId": "clx1deal001",
    "userId": "clx1usr001",
    "capturedIn": null,
    "remindAt": "2026-10-03T13:00:00.000Z",
    "remindedAt": "2026-10-03T13:00:05.000Z",
    "createdAt": "2026-09-25T18:00:00.000Z",
    "updatedAt": "2026-09-25T18:00:00.000Z",
    "contact": {
      "id": "clx1con001",
      "name": "María González"
    },
    "property": {
      "id": "clx1prop001",
      "title": "Apartamento en Chapinero con vista",
      "code": "P-0042"
    },
    "deal": {
      "id": "clx1deal001",
      "title": "Venta Apto Chapinero"
    },
    "suggestions": null
  }
}

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.