JSON

Update JSON document

Changed on

Replaces document content; requires the owner token returned at creation

put/api/json/{ns}/{id}

Request

  • Base URL: https://brewpage.app
  • URL: https://brewpage.app/api/json/{ns}/{id}
  • Auth: API key in header X-Owner-Token

Path parameters

nsstring required
idstring required

Headers

X-Owner-Tokenstring required

Owner token returned at creation. Required for update and delete

X-Delivery-Modestring

NEW publications require the hosting operation for mode changes

Request body

unknown required

Response

Document updated

idstring required
namespacestring required
linkstring required

Primary URL returned for browser viewing and sharing

ownerLinkstring required

API URL for programmatic access

sizeBytesinteger required
updatedAtstring date-time required
visibilityNoticestring

Human-readable explanation of link access and conditional public-discovery eligibility. Unlisted links are not secret; password protection applies when configured. No guarantee of listing, ranking or search-engine indexing.

managementLinkstring nullable required
routingCohortstring required
deliveryModestring nullable required
requestedDeliveryModestring nullable required
effectiveDeliveryModestring nullable required
deliveryModeMatchedboolean nullable required
accessstring required
modeLockedboolean required
hostingVersioninteger nullable required

Changes

  • 10dfacb13d63Revision changes
    • breaking

      the request's body type changed from string to no type

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      api operation id update_1 removed and replaced with update

    • info

      the endpoint scheme security OwnerToken was added to the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 753c148646ceRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status