mods

Edit mod details

Update a mod page's summary and/or description. Only the fields present in the request are changed; omitted fields are left as they are.

Text is stored in the same encoding the mod page editor uses, so the result is identical to saving the same text from the website. The caller must be on the mod's team or an admin. A mod under moderation review can only be edited by its team when staff have allowed edits.

patch/mods/{id}

Request

  • Base URL: https://api.nexusmods.com/v3
  • URL: https://api.nexusmods.com/v3/mods/{id}
  • Auth: one of:
    • API key in header apikey
    • HTTP bearer

Path parameters

idstring required

The unique identifier for the mod.

Request body

summarystring

Short description shown on mod tiles and at the top of the mod page. Line breaks and runs of whitespace are collapsed to single spaces; must not be blank once collapsed.

descriptionstring

Full mod page description, in BBCode. Must not be blank.

Response

Successfully updated the mod.

Changes

No recorded changes to this operation across all 1 revision of this API.