Ferndesk

Colecciones

Crear una colección

Crea una colección dentro de una sección. Requiere el scope content:write.

Scope requerido: content:write

POST /collections

Crear una colección

curl --request POST \
  --url 'https://api.ferndesk.com/v1/collections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "sectionId": "<string>",
  "parentCollectionId": "<string>",
  "title": "<string>",
  "subtitle": "<string>",
  "shortId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "translations": []
}

Colección creada

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de configuración del desarrollador.

    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 enviar contenido a la papelera (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 de webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de establecer scopes tienen scopes nulos = acceso total (modo heredado).

Request Body

application/json
  • title string obligatorio

    Título de la colección.

  • subtitle string | null

    Subtítulo opcional.

  • sectionId string obligatorio

    ID de la sección principal.

  • parentCollectionId string | null

    ID de la colección principal para anidamiento.

Response

application/json
  • id string

    ID de colección de Ferndesk (col_...).

  • helpdeskId string

    ID del centro de ayuda de Ferndesk (help_...).

  • sectionId string | null

    ID de la sección principal de esta colección.

  • parentCollectionId string | null

    ID de la colección principal si está anidada.

  • title string

    Título de la colección.

  • subtitle string | null

    Subtítulo opcional de la colección.

  • shortId string

    Identificador corto y fácil de reconocer.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.

  • translations[] object arraydefault

    Traducciones localizadas de la colección. Default: [].

    + Show Child Attributes
    • id string

      ID del registro de traducción de la colección.

    • collectionId string

      ID de colección de Ferndesk (col_...).

    • language string

      Código de idioma de esta traducción.

    • title string

      Título localizado de la colección.

    • subtitle string | null

      Subtítulo localizado de la colección.

    • status string

      Estado de la traducción.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.