Update a Wholesale Role

This API allows you to update wholesale role.

Request

PUT	/wp-json/wholesale/v1/roles/{role_key}

Path Parameters
role_key	required	string	Wholesale Role Key to be updated.

Body Parameters	Type	Required	Description
role_key	string	no	Wholesale Role key.
role_name	string	no	Wholesale Role name.
description	string	no	Wholesale Role description.
shipping_class_name	string	no	Shipping class name.
shipping_class_term_id	int	no	Shipping term ID.
only_allow_wholesale_purchases	string	no	Only allow wholesale purchases for this specific role. Should be "yes" or

Request Example

Postman:

Update a wholesale role

PUT: /wp-json/wholesale/v1/roles/sample_role

JSON Body:
{
    "role_name" : "New Sample Role",
    "description" : "Sample description updated",
    "shipping_class_name" : "",
    "shipping_class_term_id" : "",
    "only_allow_wholesale_purchases" : "yes"
}

Response Example

Status: 200 OK

{
    "message": "Wholesale Role \"sample_role\" has been updated.",
    "data": {
        "sample_role": {
            "roleName": "Sample Role Updated",
            "desc": "Sample description updated",
            "shippingClassName": "",
            "shippingClassTermId": "",
            "onlyAllowWholesalePurchases": "yes"
        }
    }
}