Categories (Partial Update)
Description
Creates or updates a category identified by the uuid or externalId in the request body.
If the identifier matches an existing category, it is updated. If not, a new category is created (upsert behavior). Omitted fields are left unchanged on update, or set to their defaults on creation.
See the Aerial Spec for more details.
File Naming Convention
TGEN_categories_partialupdate_2026-08_<optionalSuffix>.csv
importType:partialupdateapiVersion:2026-08
Columns
Nested object fields are flattened into columns using dot notation (parent.child). Array fields are flattened using zero-based index notation, one element per column (field[0], field[1], and so on).
Note: A whole array cannot be passed in a single column: a literal value such as ['value-1','value-2'] will be rejected. To import multiple array elements, add one indexed column per element. Rows in the table below with type array describe the field as a whole and are not valid CSV column headers.
| Column Header | Description | Key Information | Type | Required |
|---|---|---|---|---|
uuid | UUID of the resource that can be expressed using a value as defined in its types. | string | No | |
externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
parentCategory | UUID or external ID of a parent category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
parentCategory.uuid | UUID of the resource | string | No | |
parentCategory.externalId | External ID of the resource | string | No | |
status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
image | Image for this category. If the image is already stored on our servers it will not be reimported. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (localizedData[0], localizedData[1], and so on). | array | No |
localizedData[0] | Array element | mixed | No | |
localizedData[0].languageCode | Language code of localization that can be expressed using a value as defined in its types. | string | Yes | |
localizedData[0].name | Localized category name that can be expressed using a value as defined in its types. | string | No | |
localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (attributes[0], attributes[1], and so on). | array | No |
attributes[0] | Array element | mixed | No | |
attributes[0].name | Name of the attribute | string | Yes | |
attributes[0].languageExternalId | Language code of the attribute that can be expressed using a value as defined in its types. | string | Yes | |
attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0], childCategories[1], and so on). | array | No |
childCategories[0] | Array element | mixed | No | |
childCategories[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].parentCategory | UUID or external ID of a parent category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
childCategories[0].parentCategory.uuid | UUID of the resource | string | No | |
childCategories[0].parentCategory.externalId | External ID of the resource | string | No | |
childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].image | Image for this category. If the image is already stored on our servers it will not be reimported. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].localizedData[0], childCategories[0].localizedData[1], and so on). | array | No |
childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[0].localizedData[0].languageCode | Language code of localization that can be expressed using a value as defined in its types. | string | Yes | |
childCategories[0].localizedData[0].name | Localized category name that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].attributes[0], childCategories[0].attributes[1], and so on). | array | No |
childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].attributes[0].name | Name of the attribute | string | Yes | |
childCategories[0].attributes[0].languageExternalId | Language code of the attribute that can be expressed using a value as defined in its types. | string | Yes | |
childCategories[0].attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0], childCategories[0].childCategories[1], and so on). | array | No |
childCategories[0].childCategories[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].parentCategory | UUID or external ID of a parent category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].parentCategory.uuid | UUID of the resource | string | No | |
childCategories[0].childCategories[0].parentCategory.externalId | External ID of the resource | string | No | |
childCategories[0].childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].childCategories[0].image | Image for this category. If the image is already stored on our servers it will not be reimported. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].localizedData[0], childCategories[0].childCategories[0].localizedData[1], and so on). | array | No |
childCategories[0].childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].localizedData[0].languageCode | Language code of localization that can be expressed using a value as defined in its types. | string | Yes | |
childCategories[0].childCategories[0].localizedData[0].name | Localized category name that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].localizedData[0].description | Localized category description that can be expressed using a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].attributes[0], childCategories[0].childCategories[0].attributes[1], and so on). | array | No |
childCategories[0].childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].attributes[0].name | Name of the attribute | string | Yes | |
childCategories[0].childCategories[0].attributes[0].languageExternalId | Language code of the attribute that can be expressed using a value as defined in its types. | string | Yes | |
childCategories[0].childCategories[0].attributes[0].value | Value of the attribute, this will be any type casted to string but supports all basic types that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].childCategories[0], childCategories[0].childCategories[0].childCategories[1], and so on). | array | No |
childCategories[0].childCategories[0].childCategories[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].externalId | External ID of the resource that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories[0].parentCategory | UUID or external ID of a parent category that can be expressed using “SET_AS_NULL” (to reset the existing value) or a structure of {“uuid”: “string”, “externalId”: “string”} (to provide a more expressive identifier) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories[0].status | Defines the status of the category that can be expressed using a value as defined in its types. | Allowed: disabled, enabled | string | No |
childCategories[0].childCategories[0].childCategories[0].image | Image for this category. If the image is already stored on our servers it will not be reimported. that can be expressed using “SET_AS_NULL” (to reset the existing value) or a value as defined in its types. | string | No | |
childCategories[0].childCategories[0].childCategories[0].isHidden | Defines if this category should be hidden or visible that can be expressed using a value as defined in its types. | boolean | No | |
childCategories[0].childCategories[0].childCategories[0].sortOrder | Sort order of the category against other sibling categories that can be expressed using a value as defined in its types. | integer | No | |
childCategories[0].childCategories[0].childCategories[0].localizedData | A collection of Localizations of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].childCategories[0].localizedData[0], childCategories[0].childCategories[0].childCategories[0].localizedData[1], and so on). | array | No |
childCategories[0].childCategories[0].childCategories[0].localizedData[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].attributes | A collection of Attributes of the category that can be expressed using “SET_AS_NULL” (to reset all existing values) or a value as defined in its types. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].childCategories[0].attributes[0], childCategories[0].childCategories[0].childCategories[0].attributes[1], and so on). | array | No |
childCategories[0].childCategories[0].childCategories[0].attributes[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].childCategories | A collection of childCategories that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or expanded objects of the accepted type. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].childCategories[0].childCategories[0], childCategories[0].childCategories[0].childCategories[0].childCategories[1], and so on). | array | No |
childCategories[0].childCategories[0].childCategories[0].childCategories[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].childCategories[0].catalogs | A collection of catalogs that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].childCategories[0].catalogs[0], childCategories[0].childCategories[0].childCategories[0].catalogs[1], and so on). | array | No |
childCategories[0].childCategories[0].childCategories[0].catalogs[0] | Array element | mixed | No | |
childCategories[0].childCategories[0].catalogs | A collection of catalogs that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].childCategories[0].catalogs[0], childCategories[0].childCategories[0].catalogs[1], and so on). | array | No |
childCategories[0].childCategories[0].catalogs[0] | Array element | mixed | No | |
childCategories[0].catalogs | A collection of catalogs that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | Not a CSV column header. Pass each array element in its own indexed column (childCategories[0].catalogs[0], childCategories[0].catalogs[1], and so on). | array | No |
childCategories[0].catalogs[0] | Array element | mixed | No | |
catalogs | A collection of catalogs that can be expressed using “SET_AS_NULL” (to reset all existing values), uuids or external ids. | Not a CSV column header. Pass each array element in its own indexed column (catalogs[0], catalogs[1], and so on). | array | No |
catalogs[0] | Array element | mixed | No |
Sample CSV
See the following categories CSV sample file.
Note: The sample CSV may contain sample ID fields which reference other resources that do not match the data in your environment. You may omit any non-required fields from the sample CSV, reference the table above for required fields.