> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update URL Category

Updates the URL category for the specified ID. If keywords are included within the request, then they replace existing ones for the specified URL category. If the keywords attribute is not included the request, the existing keywords are retained.

You can perform a full update for the specified URL category. However, if attributes are omitted within the update request, the values for those attributes are cleared.

You can also perform an incremental update, to add or remove URLs, for the specified URL category using the action parameter. To learn more, see [URL Categories Use Cases.](https://help.zscaler.com/zia/configuring-url-categories-using-api)

<Note>
  External Documentation

  To learn more, visit the [Zscaler Internet Access documentation](https://help.zscaler.com/zia/url-categories#/urlCategories/%7BcategoryId%7D-put).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter                         | Description                                                                                                                                                                                                                                                                                     |
  | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Action                            | The action applied to the URL category (i.e. add or remove from category list). To learn more, see [URL Categories Use Cases.](https://help.zscaler.com/zia/configuring-url-categories-using-api)                                                                                               |
  | Categorized Urls                  | A comma-separated or a JSON list of URLs added to a custom URL category, will also remain linked to their original parent URL category. For more information, refer to [Zscaler Internet Access's Documentation](https://help.zscaler.com/zia/url-categories#/urlCategories/\{categoryId}-put). |
  | Category ID                       | The unique identifier for the URL category.                                                                                                                                                                                                                                                     |
  | Configured Name                   | Name of the URL category.                                                                                                                                                                                                                                                                       |
  | Custom Category                   | Set to true for custom URL category. Up to 48 custom URL categories can be added per organization.                                                                                                                                                                                              |
  | IP Ranges                         | A comma-separated or a JSON list of custom IP address ranges associated to a URL category. Up to 2000 `custom IP address ranges` and `Retaining Parent custom IP address ranges` can be added, per organization, across all categories.                                                         |
  | Keywords                          | A comma-separated or a JSON list of custom keywords associated to a URL category. Up to 2048 custom keywords can be added per organization across all categories.                                                                                                                               |
  | Retained Parent Category Keywords | A comma-separated or a JSON list of retained custom keywords from the parent URL category that is associated to a URL category. Up to 2048 retained parent keywords can be added per organization across all categories.                                                                        |
  | Super Category                    | Super category of the URL category.                                                                                                                                                                                                                                                             |
  | URL Category                      | The URL category.                                                                                                                                                                                                                                                                               |
  | URL Category Description          | Description of the URL category. Contains tag name and needs to be localized on client side if `Custom Category` is set to `false`, else it contains the user-entered description which does not have localization support.                                                                     |
  | URL Category Type                 | Type of the custom categories.                                                                                                                                                                                                                                                                  |
  | URLs                              | A comma-separated or a JSON list of custom URLs to add to a URL category. Up to 25,000 custom URLs can be added per organization across all categories.                                                                                                                                         |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | Custom IP Ranges Count          | The number of custom IP address ranges associated to the URL category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
  | Custom URLs Count               | The number of custom URLs associated to the URL category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | Editable                        | Value is set to true for custom URL category when the user has edit permission.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
  | Parent Retained IP Ranges       | A comma-separated or a JSON list of the retaining parent custom IP address ranges associated to a URL category. Up to 2000 custom `IP ranges` and `Retaining Parent custom IP address ranges` can be added, per organization, across all categories.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | Parent Retained IP Ranges Count | The number of custom IP address ranges associated to the URL category, that also need to be retained under the original parent category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | Parent Retained URLs Count      | The number of custom URLs associated to the URL category, that also need to be retained under the original parent category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | Retain Parent Keyword Count     | Count of total keywords with retain parent category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | Retain Parent Url Count         | Count of URLs with retain parent category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | Scopes                          | Scopes of the custom categories. For more information about the structure of this parameter, please refer to [Zscaler Internet Access's Documentation](https://help.zscaler.com/zia/url-categories#/urlCategories/\{categoryId}-put).<br /><br />Example:<br /><pre><code>"scopes": \[<br />    \{<br />      "scopeGroupMemberEntities": \[<br />        \{<br />          "id": 0,<br />          "name": "string",<br />          "externalId": "string",<br />          "extensions": \{<br />            "additionalProp1": "string",<br />            "additionalProp2": "string",<br />            "additionalProp3": "string"<br />          }<br />        }<br />      ],<br />      "Type": "ORGANIZATION",<br />      "ScopeEntities": \[<br />        \{<br />          "id": 0,<br />          "name": "string",<br />          "externalId": "string",<br />          "extensions": \{<br />            "additionalProp1": "string",<br />            "additionalProp2": "string",<br />            "additionalProp3": "string"<br />          }<br />        }<br />      ]<br />    }<br />  ]</code></pre> |
  | Total Keyword Count             | Total keyword count for the category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
  | Total Url Count                 | Custom URL count for the category.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
</div>

## Example Output

```json theme={"dark"}
{
	"id": "ANY",
	"configuredName": "string",
	"superCategory": "ANY",
	"keywords": [
		"string"
	],
	"keywordsRetainingParentCategory": [
		"string"
	],
	"urls": [
		"string"
	],
	"dbCategorizedUrls": [
		"string"
	],
	"ipRanges": [
		"string"
	],
	"ipRangesRetainingParentCategory": [
		"string"
	],
	"customCategory": false,
	"scopes": [
		{
			"scopeGroupMemberEntities": [
				{
					"id": 0,
					"name": "string",
					"extensions": {
						"additionalProp1": "string",
						"additionalProp2": "string",
						"additionalProp3": "string"
					}
				}
			],
			"Type": "ORGANIZATION",
			"ScopeEntities": [
				{
					"id": 0,
					"name": "string",
					"extensions": {
						"additionalProp1": "string",
						"additionalProp2": "string",
						"additionalProp3": "string"
					}
				}
			]
		}
	],
	"editable": false,
	"description": "string",
	"type": "URL_CATEGORY",
	"urlKeywordCounts": {
		"totalUrlCount": 0,
		"retainParentUrlCount": 0,
		"totalKeywordCount": 0,
		"retainParentKeywordCount": 0
	},
	"customUrlsCount": 0,
	"urlsRetainingParentCategoryCount": 0,
	"customIpRangesCount": 0,
	"ipRangesRetainingParentCategoryCount": 0
}
```

## Workflow Library Example

[Update Url Category with Zscaler Internet Access and Send Results Via Email](https://library.blinkops.com/workflows/update-url-category-with-zscaler-internet-access-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/update-url-category-with-zscaler-internet-access-and-send-results-via-email/canvas" />
</div>
