ByDomuDevelopers

Reiniciar los datos de prueba

POSThttps://api.bydomu.com/v1/test/reset

Borra todo lo de la organización de prueba y vuelve a sembrar los datos de ejemplo según su tipo de negocio (propiedades y negocios solo en inmobiliario). Se conservan el id de la organización, las claves de prueba y los webhooks (con su id y su secreto); las entregas pendientes se pierden. Solo con una clave de prueba secreta: con una de producción responde 403 TEST_MODE_ONLY.

Permiso que pide

Cualquier clave válida

Encabezado obligatorio

X-API-Key · clave publicable o secreta

Nivel de acceso

Nivel 1 · sin solicitud

Encabezados

1 · todos opcionales
Idempotency-Keystring · opcional
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

Respuesta 200

TestModeReset · 6 campos
dataid · name · vertical · seededAt · counts · webhooksKept
idstringOrganización de prueba (el id no cambia al reiniciar)
namestring
verticalstringQué datos de ejemplo se sembraron
seededAtstring
countscontacts · properties · deals · appointments · tasks · conversations · messages
contactsinteger
propertiesinteger
dealsinteger
appointmentsinteger
tasksinteger
conversationsinteger
messagesinteger
webhooksKeptintegerWebhooks conservados (mismo id y mismo secreto)

Errores posibles

con la forma { "error": { "code", "message" } }
  • 400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
  • 401UNAUTHORIZED
  • 402PAYMENT_REQUIRED
  • 403FORBIDDEN
  • 409DUPLICATE
  • 429RATE_LIMITED
  • 500INTERNAL_ERROR
PeticiónPOST/v1/test/reset
SDK oficial · @bydomu/sdk · aún no está en npm
import { ByDomu } from "@bydomu/sdk";

const bydomu = new ByDomu({
  apiKey: process.env.BYDOMU_API_KEY,
});

const { data } = await bydomu.test.resetData();
200 OK · ejemplo
{
  "data": {
    "id": "clx1org002",
    "name": "Inmobiliaria Andes (prueba)",
    "vertical": "REAL_ESTATE",
    "seededAt": "2026-09-28T21:30:00.000Z",
    "counts": {
      "contacts": 8,
      "properties": 6,
      "deals": 5,
      "appointments": 4,
      "tasks": 5,
      "conversations": 3,
      "messages": 6
    },
    "webhooksKept": 1
  }
}