NAnationbuilder
Pages

Update an existing page

Changed on

Updates an existing page

patch/api/v2/pages/{id}

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Query parameters

includePageSideloadValues[]

Comma-delimited list of sideloaded resources to include as part of the page response. See guidance here about sideloading large numbers of resources and pagination.

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "pages",
    "attributes": {
      "author_id": "1",
      "excerpt": "Page excerpt...",
      "external_id": "abc",
      "headline": "Page headline",
      "name": "Page Name",
      "page_type_name": "Basic",
      "parent_id": "1",
      "permission_level": "anyone",
      "site_id": "1",
      "slug": "your-slug",
      "status": "unlisted",
      "title": "Page Title"
    }
  }
}

Response

The updated page.

metaobject

Non-standard information about the document. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": {
    "id": "1",
    "type": "pages",
    "attributes": {
      "author_id": "1",
      "excerpt": "Page excerpt...",
      "external_id": "abc",
      "headline": "Page headline",
      "name": "Page Name",
      "page_type_name": "Basic",
      "parent_id": "1",
      "permission_level": "anyone",
      "site_id": "1",
      "slug": "your-slug",
      "status": "unlisted",
      "title": "Page Title",
      "ancestors_permission_level": "members",
      "effective_permission_level": "control_panel_users",
      "parent_slug": "blog",
      "published_at": "2019-10-26T10:00:00-04:00",
      "url_path": "/your-slug"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      added subschema #2 to the request body allOf list

    • breaking

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

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter include, the type changed from string to array

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the media type application/vnd.api+json to the request body

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31995b0a1e61Revision changes
    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • info

      added the new optional query request parameter include

    • 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

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status