profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingBiblioteca multimedia

Sin interfaz

Inicio rápidojson y código de ClaudeComponent Zod Pull

Api rest

Visión general de la API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postTraducción de publicacionespatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Realiza una inserción o actualización de una variante de documento de un componente personalizado, indexada por el id del documento.

Realiza una operación de inserción o actualización de una variante (una fila de documents) de un componente personalizado, indexada por el id del documento. Proporciona id para actualizar una variante existente; omítelo para insertar una nueva. También está disponible en /schemas/{schema_name}. El contenido se valida con el esquema del componente.

Auth: clave de API — siempre obligatoria, y la clave debe incluir el permiso content_write.

Parámetros de ruta

ParámetroTipoObligatorioNotas
schema_namecadenasíEl nombre del componente personalizado.

Parámetros de consulta

ParámetroTipoObligatorioNotas
websiteIduuidnoSitio web de destino; recurre al encabezado Host o a la configuración.
api_keycadenanoAlternativa al encabezado x-api-key.

Cuerpo de la solicitud

{
  "id": "<uuid>",
  "title": "Mi variante",
  "content": { "title": "Hola", "body": "..." }
}
CampoTipoObligatorioNotas
iduuidnoActualiza la variante coincidente cuando está presente; inserta cuando falta o no se encuentra.
titlecadenanoTítulo visible. Toma por defecto "Sin título" al insertar; se deja sin cambios en la actualización cuando se omite.
contentobjetosíValores de los campos, validados con el esquema del componente. Debe ser un objeto JSON.

Respuesta

{
  "id": "...",
  "schema_name": "publicación",
  "title": "Mi variante",
  "status": "borrador",
  "version": 2,
  "created": true
}

created es true en una inserción (HTTP 201) y false en una actualización (HTTP 200).

Ejemplo

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Hello"}}'

Errores

  • 400 — websiteId inválido, content que no es un objeto, componente desconocido o archivado, o fallo de validación
  • 401 — falta la clave de API o es inválida
  • 403 — la clave no tiene el permiso content_write
  • 404 — se proporcionó id pero no hay una variante coincidente
Continue Reading
Previous‹GET /content-changes (SSE)NextTraducción de publicaciones›