Skip to main content

WordPress Operations Reference

Orkes Conductor integrates with WordPress to let you create and manage posts, pages, media, and taxonomies directly from your workflows. Once you configure the WordPress integration, you can use the following operations to create, retrieve, update, and delete content in WordPress, without leaving your workflow.

This page covers the parameters and expected output for each operation available in the WordPress integration.

Get Me

Get the current authenticated user profile in WordPress.

This operation has no input parameters.

Create Post

Create a new post or page in WordPress.

ParameterDescriptionTypeRequired/Optional
TypeThe content type. Supported values:
  • post (default)
  • page
stringOptional.
TitleThe title of the post or page.stringRequired.
ContentThe content of the post or page. HTML is supported.stringRequired.
StatusThe post status. Supported values:
  • draft (default)
  • publish
  • pending
  • private
stringOptional.
ExcerptThe post excerpt.stringOptional.
CategoriesThe category names or IDs, entered as comma-separated values. Applicable to posts only.stringOptional.
TagsThe tag names or IDs, entered as comma-separated values. Applicable to posts only.stringOptional.
Featured MediaThe media ID of the featured image.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.
integerOptional.
ParentThe ID of the parent page. Used to nest the new page under an existing page, supporting multi-level hierarchies. Applicable to pages only.integerOptional.
Menu OrderThe menu order of the page. Applicable to pages only.integerOptional.

Update Post

Update an existing post or page in WordPress. It cannot update the type, which means it can't change a page to a post and vice versa.

ParameterDescriptionTypeRequired/Optional
Post IdThe ID of the post or page to update.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.
integerRequired.
TitleThe updated title of the post or page.stringOptional.
ContentThe updated content of the post or page. HTML is supported.stringRequired.
StatusThe updated post status. Supported values:
  • draft
  • publish
  • pending
  • private
stringOptional.
ExcerptThe updated post excerpt.stringOptional.
CategoriesThe updated category names or IDs, entered as comma-separated values. Applicable to posts only.stringOptional.
TagsThe updated tag names or IDs, entered as comma-separated values. Applicable to posts only.stringOptional.
Featured MediaThe updated media ID of the featured image.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.
integerOptional.
ParentThe ID of an existing published page to set as the parent. When updated, the page is moved under the specified parent in the hierarchy. Applicable to pages only.integerOptional.
Menu OrderThe updated menu order of the page. Applicable to pages only.integerOptional.
Note

In addition to the mandatory field Post ID, at least one other field must also be provided for the operation to work.

Delete Post

Delete a post or page by ID. The post or page is moved to trash and can be recovered from the WordPress admin panel.

ParameterDescriptionTypeRequired/Optional
Post idThe ID of the post or page to delete.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.
integerRequired.
TypeThe content type for validation. Supported values:
  • post
  • page
stringOptional.

Get Post

Get a specific post or page by ID.

ParameterDescriptionTypeRequired/Optional
Post idThe ID of the post or page to retrieve.
To get the post ID, open the post or page in the WordPress admin panel. The ID is the value of the post parameter in the URL: https://<YOUR-SITE>/wp-admin/post.php?post=<POST-ID>&action=edit.
integerRequired.
TypeThe content type for validation. Supported values:
  • post
  • page
stringOptional.

List Posts

List posts or pages with optional filters.

ParameterDescriptionTypeRequired/Optional
TypeThe type to filter. Supported values:
  • page
  • post
stringOptional.
Per PageThe number of items to return per page. Maximum value is 100. Default is 20.integerOptional.
PageThe page number for pagination. Default is 1.integerOptional.
StatusThe status to filter. Supported values:
  • publish
  • draft
  • pending
  • private
  • any (default)
stringOptional.
SearchThe search term.stringOptional.
Order BySort field. Supported values:
  • date
  • modified (default)
  • title
stringOptional.
OrderThe sorting order. Supported values:
  • ASC
  • DESC (default)
stringOptional.

List Tags

List all tags in the Wordpress site.

ParameterDescriptionTypeRequired/Optional
Per PageThe number of tags to return per page. Maximum value is 100. Default is 100.integerOptional.
PageThe page number for pagination. Default is 1.integerOptional.

List Categories

List all categories in the WordPress site.

ParameterDescriptionTypeRequired/Optional
Per PageThe number of categories to return per page. Maximum value is 100. Default is 100.integerOptional.
PageThe page number for pagination. Default is 1.integerOptional.

Upload Media

Upload a media file to WordPress from a URL.

ParameterDescriptionTypeRequired/Optional
Media UrlThe publicly accessible URL of the media file to upload.stringRequired.

Get Media

Get a specific media item by ID.

ParameterDescriptionTypeRequired/Optional
Media IdThe unique identifier of the media item to retrieve.
To get the media ID, open the media item in the WordPress admin panel. The ID is the value of the item parameter in the URL: https://<YOUR-SITE>/wp-admin/upload.php?item=<MEDIA-ID>.
integerRequired.

List Media

List all media items.

ParameterDescriptionTypeRequired/Optional
Per PageThe number of media items to return per page. Maximum value is 100. Default is 50.integerOptional.
PageThe page number for pagination. Default is 1.integerOptional.