Ferndesk

Artículos

Mover un artículo

Mueve un artículo a una colección y/o sección diferente. Requiere el scope content:write.

Scope requerido: content:write

POST /articles/{id}/move

Mover un artículo

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/move' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>"
}

Artículo movido

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página Developer settings.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar la publicación, restaurar y eliminar contenido (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la configuración de scopes tienen scopes nulos = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID de recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Request Body

application/json
  • collection_id string | null

    ID de la colección de destino o null para quitarlo de cualquier colección.

  • section_id string

    ID de la sección de destino.

Response

application/json
  • id string

    ID del artículo de Ferndesk (art_...).

  • title string

    Título principal del artículo.

  • slug string | null

    Slug de URL del artículo.

  • contentHtml string

    Contenido del artículo renderizado como HTML. Presente cuando format=html (predeterminado).

  • contentMarkdown string

    Contenido del artículo renderizado como Markdown. Presente cuando format=markdown.

  • contentJson any | null

    Documento ProseMirror/Tiptap sin procesar almacenado. Presente cuando format=json. Utiliza el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps, cards) y es la representación sin pérdida.

  • url string (uri) | null

    URL pública canónica de este artículo.

  • sectionId string | null

    ID de la sección que contiene el artículo.

  • collectionId string | null

    ID de agrupación de colección opcional para el artículo.

  • status string | null

    Estado de publicación del artículo.

  • publishedAt string | null

    Marca de tiempo de publicación del artículo.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.