Resources

Update the specified resource

Changed on Mar 18, 2026

Update the specified resource.

post/resources/{id}/

Request

Base URL
https://example.com/api
Auth
- OAuth 2
  Authorization codehttps://example.com/oauth2/authorize
  Token URLhttps://example.com/api/oauth2/token
  Scopesresource:write
- or API key in header XF-Api-Key
TypeScript
https://skmtc.dev/xenforo-ltd/apis/xenforo-api/docs/resources/:id/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

prefix_idinteger

titlestring

version_stringstring

descriptionstring

external_download_urlstring

custom_fields[<name>]string

add_tagsstring[]

remove_tagsstring[]

tag_linestring

external_urlstring

alt_support_urlstring

currencystring

external_purchase_urlstring

attachment_keystring

API attachment key for description images

author_alertboolean

author_alert_reasonstring

Response

OK

successboolean

Changes

Mar 18, 2026e271d0e41f6d Revision changes
- breaking
  removed the media type application/json from the request body
- breaking
  the response's property type changed from string to boolean for status
- warning
  deleted the path request parameter id
- warning
  removed the request property
- info
  api operation id post_resources_id_ removed and replaced with postResourcesId
- info
  the endpoint scheme security XF-Api-Key was added to the API
- info
  the endpoint scheme security XF-OAuth2 was added to the API
- info
  added the new optional header request parameter XF-Api-User to all path's operations
- info
  added the new optional query request parameter api_bypass_permissions to all path's operations
Mar 6, 20260f490cfb7931 Revision changes
- info
  api tag Resources added
- info
  api tag resources removed
- info
  added optional request body
- info
  added the media type application/json for the response with the status

Operation history (4 revisions)