FOforem
pages

update details for a page

Changed on

Update an existing page's details by ID. Requires site administrative privileges, or organization admin privileges for pages belonging to an organization. Successful writes log api_page_update with the actor and target ids in the admin API audit log.

put/api/pages/{id}

Request

  • Base URL
    https://dev.to
  • Auth
    • API key in header api-key
    • or HTTP bearer

Path parameters

idinteger required

The ID of the page to update.

Request body

titlestring required

Title of the page

slugstring required

Used to link to this page in URLs, must be unique and URL-safe

descriptionstring required

For internal use, helps similar pages from one another

body_markdownstring nullable

The text (in markdown) of the ad (required)

body_jsonstring nullable

For JSON pages, the JSON body

is_top_level_pathboolean

If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution

social_imageobject nullable
organization_idinteger nullable

The ID of the organization the page belongs to, if any

positioninteger

Display order position for organization pages

template'contained' | 'full_within_layout' | 'nav_bar_included' | 'json' | 'css' | 'txt' required

Controls what kind of layout the page is rendered in

Response

successful

titlestring required

Title of the page

slugstring required

Used to link to this page in URLs, must be unique and URL-safe

descriptionstring required

For internal use, helps similar pages from one another

body_markdownstring nullable

The text (in markdown) of the ad (required)

body_jsonstring nullable

For JSON pages, the JSON body

is_top_level_pathboolean

If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution

social_imageobject nullable
organization_idinteger nullable

The ID of the organization the page belongs to, if any

positioninteger

Display order position for organization pages

template'contained' | 'full_within_layout' | 'nav_bar_included' | 'json' | 'css' | 'txt' required

Controls what kind of layout the page is rendered in

Changes

  • v10c2dc5146f56Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • v17db6ba099285Revision changes
    • breaking

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

    • breaking

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