Update a category

Updates a category's name, slug, description, parent, or schema. Moving a category to a different parent re-organizes the tree.

Required permissions
categories.update
PUT/categories/{id}
Base URLhttps://api.lynkow.com/v1

Path parameters

idstringrequired

Unique identifier

Request bodyrequired

  • namestring

    Display name. 1-255 characters

  • slugstring

    URL-friendly identifier, unique per site and locale. 1-255 characters

  • imageunion

    Image URL

  • schemaobject

    Field schema definition

    • fieldsarray<any>required
  • parentIdunion

    Parent resource ID

  • contentModeenum

    One of: standard, structured

    One of: standardstructured

  • descriptionunion

    Description text

  • jsonLdGrapharray<object>

    Max 50 characters. Array of objects

    • idstring
    • dataanyrequired
    • typestringrequired
    • sourceenum

      One of: presetcustom

  • displayOrdernumber

    Number

  • schemaSourceenum

    One of: own, inherit

    One of: owninherit

  • sitemapPriorityunion

    Sitemap priority (0.0-1.0)

  • jsonLdExclusionsarray<string>

    Max 50 characters. Array of strings

  • sitemapChangefrequnion

    Sitemap change frequency (daily, weekly, monthly)

Feedback

Was this page helpful?