Update Product Category

This API lets you make changes to a product category.

PUT/products/categories/{categoryId}

Use it in a workflow

Add a step and choose the WooCommerce connector.
Pick the Update Product Category action (under Product categories).
Fill in the fields below, then reference the result from later steps as {{updateProductCategory.response.data}}.

Request

Path parameters

categoryIdintegerrequired

ID of product category to update

Request body

Enter the body as JSON in the step's Body field.

idinteger

Unique identifier for the resource.

namestringrequired

Category name.

slugstring

An alphanumeric identifier for the resource unique to its type.

parentinteger

The ID for the parent of the resource.

descriptionstring

HTML description of the resource.

displaystring

Category archive display type.

One ofdefaultproductssubcategoriesbothDefault "default"

imageobject

idinteger

Image ID.

date_createdstring (date-time)

The date the image was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the image was created, as GMT. read-only

date_modifiedstring (date-time)

The date the image was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the image was last modified, as GMT. read-only

srcstring

Image URL.

namestring

Image name.

altstring

Image alternative text.

menu_orderinteger

Menu order, used to custom sort the resource.

countinteger

Number of published products for the resource.

json

{
  "name": "string",
  "id": 0,
  "slug": "string",
  "parent": 0,
  "description": "string",
  "display": "default",
  "image": {
    "id": 0,
    "date_created": "2025-01-01T00:00:00Z",
    "date_created_gmt": "2025-01-01T00:00:00Z",
    "date_modified": "2025-01-01T00:00:00Z",
    "date_modified_gmt": "2025-01-01T00:00:00Z",
    "src": "string",
    "name": "string",
    "alt": "string"
  },
  "menu_order": 0,
  "count": 0
}

Response

Returns 200 with an object. Read it in later steps with {{updateProductCategory.response.data.<field>}}.

idinteger

Unique identifier for the resource.

namestring

Category name.

slugstring

An alphanumeric identifier for the resource unique to its type.

parentinteger

The ID for the parent of the resource.

descriptionstring

HTML description of the resource.

displaystring

Category archive display type.

One ofdefaultproductssubcategoriesbothDefault "default"

imageobject

idinteger

Image ID.

date_createdstring (date-time)

The date the image was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the image was created, as GMT. read-only

date_modifiedstring (date-time)

The date the image was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the image was last modified, as GMT. read-only

srcstring

Image URL.

namestring

Image name.

altstring

Image alternative text.

menu_orderinteger

Menu order, used to custom sort the resource.

countinteger

Number of published products for the resource.

json

{
  "name": "string",
  "id": 0,
  "slug": "string",
  "parent": 0,
  "description": "string",
  "display": "default",
  "image": {
    "id": 0,
    "date_created": "2025-01-01T00:00:00Z",
    "date_created_gmt": "2025-01-01T00:00:00Z",
    "date_modified": "2025-01-01T00:00:00Z",
    "date_modified_gmt": "2025-01-01T00:00:00Z",
    "src": "string",
    "name": "string",
    "alt": "string"
  },
  "menu_order": 0,
  "count": 0
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.

Was this page helpful?