Insira ou atualize uma variante de documento de um componente personalizado, indexada pelo id do documento.
Insira ou atualize uma variante (uma linha de documents) de um componente personalizado, indexada pelo id do documento. Forneça o id para atualizar uma variante existente; omita-o para inserir uma nova. Também disponível em /schemas/{schema_name}. O conteúdo é validado em relação ao esquema do componente.
Autenticação: chave de API — sempre obrigatória, e a chave deve possuir a permissão content_write.
| Parâmetro | Tipo | Obrigatório | Observações |
|---|---|---|---|
schema_name | string | sim | Nome do componente personalizado. |
| Parâmetro | Tipo | Obrigatório | Observações |
|---|---|---|---|
websiteId | uuid | não | Site de destino; recorre ao cabeçalho/configuração Host. |
api_key | string | não | Alternativa ao cabeçalho x-api-key. |
{
"id": "<uuid>",
"title": "Minha variante",
"content": { "title": "Olá", "body": "..." }
}
| Campo | Tipo | Obrigatório | Observações |
|---|---|---|---|
id | uuid | não | Atualiza a variante correspondente quando presente; insere quando ausente ou não encontrada. |
title | string | não | Título exibido. Assume "Untitled" por padrão na inserção; permanece inalterado na atualização quando omitido. |
content | object | sim | Valores dos campos, validados em relação ao esquema do componente. Deve ser um objeto JSON. |
{
"id": "...",
"schema_name": "post",
"title": "Minha variante",
"status": "draft",
"version": 2,
"created": true
}
created é true na inserção (HTTP 201) e false na atualização (HTTP 200).
curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <key>' \
-H 'Content-Type: application/json' \
-d '{"content":{"title":"Olá"}}'
400 — websiteId inválido, content que não é objeto, componente desconhecido ou arquivado, ou falha de validação401 — chave de API ausente ou inválida403 — a chave não possui a permissão content_write404 — id fornecido, mas nenhuma variante correspondente