Pages API

Create, retrieve, update and delete Woorise pages.

List all pages

Retrieve a paginated list of pages. By default, only published pages are returned. Use status=any to include other page statuses, or status=trash for pages in Trash.

GET /pages

Request parameters

ParameterTypeRequiredDescription
contextstringnoview, edit, embed. Defaults to view. Use edit to include editable title and content.
pageintegernoResults page number, starting at 1. Defaults to 1.
per_pageintegernoItems per page, from 1 to 100. Defaults to 10.
searchstringnoSearch page text.
statusarray of stringsnopublish, future, draft, pending, private, trash, any. Defaults to publish.
slugarray of stringsnoReturn pages with these URL slugs.
includearray of integersnoReturn only these page IDs.
excludearray of integersnoExclude these page IDs.
authorarray of integersnoReturn pages assigned to these author IDs.
author_excludearray of integersnoExclude pages assigned to these author IDs.
afterstringnoReturn pages published after this ISO 8601 date and time.
beforestringnoReturn pages published before this ISO 8601 date and time.
modified_afterstringnoReturn pages updated after this ISO 8601 date and time.
modified_beforestringnoReturn pages updated before this ISO 8601 date and time.
orderstringnoasc, desc. Defaults to desc.
orderbystringnoauthor, date, id, include, modified, parent, relevance, slug, include_slugs, title. Defaults to date. Use relevance with search.
offsetintegernoSkip this many matching pages.
search_columnsarray of stringsnoLimit search to post_title, post_content, post_excerpt.
_fieldsstringnoReturn only the specified fields, separated by commas. For example, id,title,status.

Array parameters accept comma-separated values, for example include=420,421.

Example request

GET /pages

Response

200 OK
X-WP-Total: 1
X-WP-TotalPages: 1
[
  {
    "id": 420,
    "date": "2026-11-01T10:00:00",
    "modified": "2026-11-02T10:00:00",
    "slug": "autumn-giveaway",
    "status": "publish",
    "link": "https://woorise.com/acme/autumn-giveaway",
    "title": {
      "rendered": "Autumn giveaway"
    },
    "content": {
      "rendered": "\n<p>Enter our autumn giveaway.</p>\n",
      "protected": false
    },
    "author": 7,
    "meta": {
      "share_title": "",
      "share_description": "",
      "share_image_id": 0,
      "allow_indexing": false,
      "host_page_url": "",
      "starts_at": "",
      "form_id": 65,
      "ends_at": "2026-11-30T23:59:00+02:00",
      "language": {},
      "gallery": {},
      "wheel_prizes": []
    },
    "_links": {
      "self": [
        {
          "href": "https://api.woorise.com/pages/420",
          "targetHints": {
            "allow": [
              "GET",
              "POST",
              "PUT",
              "PATCH",
              "DELETE"
            ]
          }
        }
      ],
      "collection": [
        {
          "href": "https://api.woorise.com/pages"
        }
      ]
    }
  }
]

The response body is an array. X-WP-Total is the number of matching pages; X-WP-TotalPages is the number of results pages. Request page=2 for the next page. No matches return [].

Get a page

Retrieve a page by its ID.

GET /pages/{page_id}

Request parameters

ParameterTypeRequiredDescription
page_idintegeryesPage ID in the URL.
contextstringnoview, edit, embed. Defaults to view. Use edit to include editable title and content. embed returns a shorter response.
passwordstringnoPage password, if required to access protected content.
_fieldsstringnoReturn only the specified fields, separated by commas.

Example request

GET /pages/420?context=edit

Response

200 OK
{
  "id": 420,
  "date": "2026-11-01T10:00:00",
  "modified": "2026-11-02T10:00:00",
  "password": "",
  "slug": "autumn-giveaway",
  "status": "publish",
  "link": "https://woorise.com/acme/autumn-giveaway",
  "title": {
    "raw": "Autumn giveaway",
    "rendered": "Autumn giveaway"
  },
  "content": {
    "raw": "<!-- wp:paragraph -->\n<p>Enter our autumn giveaway.</p>\n<!-- /wp:paragraph -->",
    "rendered": "\n<p>Enter our autumn giveaway.</p>\n",
    "protected": false,
    "block_version": 1
  },
  "author": 7,
  "meta": {
    "share_title": "",
    "share_description": "",
    "share_image_id": 0,
    "allow_indexing": false,
    "host_page_url": "",
    "starts_at": "",
    "form_id": 65,
    "ends_at": "2026-11-30T23:59:00+02:00",
    "language": {},
    "gallery": {},
    "wheel_prizes": []
  },
  "_links": {
    "self": [
      {
        "href": "https://api.woorise.com/pages/420",
        "targetHints": {
          "allow": [
            "GET",
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ]
        }
      }
    ],
    "collection": [
      {
        "href": "https://api.woorise.com/pages"
      }
    ]
  }
}

title.raw and content.raw contain editable text. content.rendered contains display HTML. date and modified use the site timezone. meta.form_id is read-only; 0 means no Woorise form is linked.

Create a page

Create a page. Provide a title, content, or both. The page is saved as a draft unless you specify another status. Publishing requires permission to publish pages.

POST /pages

Request parameters

ParameterTypeRequiredDescription
titlestring or objectnoPage title. Send a string or an object with a raw string.
contentstring or objectnoPage content as HTML or block editor content. Send a string or an object with a raw string.
slugstringnoPage URL slug.
statusstringnopublish, future, draft, pending, private. Defaults to draft.
datestring or nullnoPublication date and time in the site timezone, in ISO 8601 format. Use a future date with status=future to schedule publication.
passwordstringnoPage password. Send an empty string to remove it.
authorintegernoAuthor user ID. Defaults to the authenticated user. Assigning another author requires permission.
metaobjectnoPage settings. Send the following settings inside this object.
meta.starts_atstringnoDate and time the page opens, in ISO 8601 format. Send an empty string to clear it.
meta.ends_atstringnoDate and time the page closes, in ISO 8601 format. Send an empty string to clear it.
meta.share_titlestringnoTitle for search results and link previews. Send an empty string to use the page title.
meta.share_descriptionstringnoDescription for search results and link previews. Send an empty string to use the default description.
meta.share_image_idintegernoAccessible image ID on this site. Send 0 to use the default image. Defaults to 0.
meta.allow_indexingbooleannoAllow search engines to index this page, subject to site settings. Defaults to false.
meta.host_page_urlstringnoHTTP or HTTPS URL where the campaign is embedded. Send an empty string to clear it.
meta.languageobjectnoPage language and custom text.
meta.galleryobjectnoGallery display, voting and sharing settings.
meta.wheel_prizesarray of objectsnoPrize labels displayed on the wheel. Send an empty array to clear them.

Use date-time values such as 2026-12-31T23:59:00+02:00. starts_at and ends_at control when the campaign opens and closes; date controls publication.

Creating a page does not create a Woorise form. Creating a Woorise form also creates its linked draft page. meta.form_id cannot be set or changed through this request.

Example request

POST /pages
{
  "title": "Winter giveaway",
  "content": "<!-- wp:paragraph -->\n<p>Enter our winter giveaway.</p>\n<!-- /wp:paragraph -->",
  "status": "draft",
  "meta": {
    "ends_at": "2026-12-31T23:59:00+02:00",
    "share_title": "Win a winter gift box"
  }
}

Response

201 Created
Location: https://api.woorise.com/pages/421
{
  "id": 421,
  "date": "2026-11-02T10:00:00",
  "modified": "2026-11-02T10:00:00",
  "password": "",
  "slug": "",
  "status": "draft",
  "link": "https://woorise.com/acme/?p=421",
  "title": {
    "raw": "Winter giveaway",
    "rendered": "Winter giveaway"
  },
  "content": {
    "raw": "<!-- wp:paragraph -->\n<p>Enter our winter giveaway.</p>\n<!-- /wp:paragraph -->",
    "rendered": "\n<p>Enter our winter giveaway.</p>\n",
    "protected": false,
    "block_version": 1
  },
  "author": 7,
  "meta": {
    "share_title": "Win a winter gift box",
    "share_description": "",
    "share_image_id": 0,
    "allow_indexing": false,
    "host_page_url": "",
    "starts_at": "",
    "form_id": 0,
    "ends_at": "2026-12-31T23:59:00+02:00",
    "language": {},
    "gallery": {},
    "wheel_prizes": []
  },
  "_links": {
    "self": [
      {
        "href": "https://api.woorise.com/pages/421",
        "targetHints": {
          "allow": [
            "GET",
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ]
        }
      }
    ],
    "collection": [
      {
        "href": "https://api.woorise.com/pages"
      }
    ]
  }
}

Update a page

Update an existing page. Send only the fields you want to change. POST and PATCH are also supported.

PUT /pages/{page_id}

Request parameters

ParameterTypeRequiredDescription
page_idintegeryesPage ID in the URL.
titlestring or objectnoPage title. Send a string or an object with a raw string.
contentstring or objectnoPage content as HTML or block editor content. Send a string or an object with a raw string.
slugstringnoPage URL slug.
statusstringnopublish, future, draft, pending, private.
datestring or nullnoPublication date and time in the site timezone, in ISO 8601 format. Use a future date with status=future to schedule publication.
passwordstringnoPage password. Send an empty string to remove it.
authorintegernoAuthor user ID. Assigning another author requires permission.
metaobjectnoPage settings. Send the following settings inside this object.

The meta object accepts the same settings listed under Create a page. Omitted fields and omitted settings keep their current values. The status and author remain unchanged when omitted.

A supplied content replaces the entire page body. Supplied language, gallery and wheel_prizes settings replace their saved values; include the nested settings you want to retain. Send null for a writable metadata key to reset it to its default.

Example request

PUT /pages/420
{
  "title": "Autumn giveaway extended",
  "meta": {
    "ends_at": "2026-12-05T23:59:00+02:00"
  }
}

Response

200 OK
{
  "id": 420,
  "date": "2026-11-01T10:00:00",
  "modified": "2026-11-02T11:00:00",
  "password": "",
  "slug": "autumn-giveaway",
  "status": "publish",
  "link": "https://woorise.com/acme/autumn-giveaway",
  "title": {
    "raw": "Autumn giveaway extended",
    "rendered": "Autumn giveaway extended"
  },
  "content": {
    "raw": "<!-- wp:paragraph -->\n<p>Enter our autumn giveaway.</p>\n<!-- /wp:paragraph -->",
    "rendered": "\n<p>Enter our autumn giveaway.</p>\n",
    "protected": false,
    "block_version": 1
  },
  "author": 7,
  "meta": {
    "share_title": "",
    "share_description": "",
    "share_image_id": 0,
    "allow_indexing": false,
    "host_page_url": "",
    "starts_at": "",
    "form_id": 65,
    "ends_at": "2026-12-05T23:59:00+02:00",
    "language": {},
    "gallery": {},
    "wheel_prizes": []
  },
  "_links": {
    "self": [
      {
        "href": "https://api.woorise.com/pages/420",
        "targetHints": {
          "allow": [
            "GET",
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ]
        }
      }
    ],
    "collection": [
      {
        "href": "https://api.woorise.com/pages"
      }
    ]
  }
}

Delete a page

Move a page to Trash. Set force=true to permanently delete it.

DELETE /pages/{page_id}

Request parameters

ParameterTypeRequiredDescription
page_idintegeryesPage ID in the URL.
forcebooleannoPermanently delete the page. Defaults to false.

Example request

DELETE /pages/420

Response

200 OK
{
  "id": 420,
  "date": "2026-11-01T10:00:00",
  "modified": "2026-11-02T11:05:00",
  "password": "",
  "slug": "autumn-giveaway__trashed",
  "status": "trash",
  "link": "https://woorise.com/acme/autumn-giveaway__trashed",
  "title": {
    "raw": "Autumn giveaway extended",
    "rendered": "Autumn giveaway extended"
  },
  "content": {
    "raw": "<!-- wp:paragraph -->\n<p>Enter our autumn giveaway.</p>\n<!-- /wp:paragraph -->",
    "rendered": "\n<p>Enter our autumn giveaway.</p>\n",
    "protected": false,
    "block_version": 1
  },
  "author": 7,
  "meta": {
    "share_title": "",
    "share_description": "",
    "share_image_id": 0,
    "allow_indexing": false,
    "host_page_url": "",
    "starts_at": "",
    "form_id": 65,
    "ends_at": "2026-12-05T23:59:00+02:00",
    "language": {},
    "gallery": {},
    "wheel_prizes": []
  },
  "_links": {
    "self": [
      {
        "href": "https://api.woorise.com/pages/420",
        "targetHints": {
          "allow": [
            "GET",
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ]
        }
      }
    ],
    "collection": [
      {
        "href": "https://api.woorise.com/pages"
      }
    ]
  }
}

To restore a page from Trash, update its status to draft or another supported status.

DELETE /pages/420?force=true
200 OK
{
  "deleted": true,
  "previous": {
    "id": 420,
    "date": "2026-11-01T10:00:00",
    "modified": "2026-11-02T11:05:00",
    "password": "",
    "slug": "autumn-giveaway__trashed",
    "status": "trash",
    "link": "https://woorise.com/acme/autumn-giveaway__trashed",
    "title": {
      "raw": "Autumn giveaway extended",
      "rendered": "Autumn giveaway extended"
    },
    "content": {
      "raw": "<!-- wp:paragraph -->\n<p>Enter our autumn giveaway.</p>\n<!-- /wp:paragraph -->",
      "rendered": "\n<p>Enter our autumn giveaway.</p>\n",
      "protected": false,
      "block_version": 1
    },
    "author": 7,
    "meta": {
      "share_title": "",
      "share_description": "",
      "share_image_id": 0,
      "allow_indexing": false,
      "host_page_url": "",
      "starts_at": "",
      "form_id": 65,
      "ends_at": "2026-12-05T23:59:00+02:00",
      "language": {},
      "gallery": {},
      "wheel_prizes": []
    }
  }
}

Join more than 80,000 brands using Woorise

Easily create landing pages, forms, surveys, quizzes & viral giveaways that drive real user engagement.