---
updatedAt: 2026-05-29T15:08:02.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Update Inventory Status

Use this API to change the existing status of an inventory.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Privacy Automation - Data Mapping Automation",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Data Mapping Automation APIs are used to manage structured records (assets, vendors, processing activities, and legal entities), define schema attributes, traverse parent–child hierarchies, and create cross-record relationships—including links to personal data."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Inventory",
      "description": "APIs used to create and manage inventory records for supported schema types (processing-activities, vendors, assets, entities).",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-mapping-automation.json"
      }
    }
  ],
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0",
    "links": [
      "{'Data Mapping Automation Knowledge Base': 'https://my.onetrust.com/s/topic/0TO1Q000000ItRxWAK/data-mapping-automation'}"
    ]
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "paths": {
    "/api/inventory/v2/inventories/{schemaName}/{id}/status": {
      "put": {
        "operationId": "updateInventoryStatusByIdUsingPUT",
        "summary": "Update Inventory Status",
        "description": "Use this API to change the existing status of an inventory.",
        "tags": [
          "Inventory"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/privacy-automation-data-mapping-automation.json"
        },
        "parameters": [
          {
            "name": "schemaName",
            "in": "path",
            "description": "The `name` property of the schema.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "processing-activities",
                "vendors",
                "assets",
                "entities"
              ]
            },
            "example": "vendors"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The unique identifier of an inventory record.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "c79fb1a9-9406-4e9b-bff7-c72e635ee82b"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/KeyNameDto"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK - Inventory status successfully updated."
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "OAUTH2": [
              "INVENTORY",
              "INVENTORY_WRITE",
              "DATA_MAPPING_INVENTORY_CHANGE_STATUS"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "KeyNameDto": {
        "type": "object",
        "properties": {
          "key": {
            "description": "The key identifier",
            "type": "string",
            "example": "active"
          },
          "name": {
            "description": "The display name associated with the key",
            "type": "string",
            "example": "Active"
          }
        },
        "required": [
          "key"
        ]
      }
    },
    "securitySchemes": {
      "OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "INVENTORY": "Inventory Scope gives the user access to read/write operations",
              "INVENTORY_READ": "Inventory Read Scope gives the user read-only access",
              "INVENTORY_WRITE": "Inventory Write Scope gives the user write access"
            }
          }
        }
      }
    }
  }
}
```

# Sibling pages

* [Get List of Inventories](https://developer.onetrust.com/onetrust/reference/getlistofinventoriesusingget.md)
* [Get List of Inventories by Criteria](https://developer.onetrust.com/onetrust/reference/getlistofinventoriesbyfiltercriteriausingpost.md)
* [Get Inventory by External ID](https://developer.onetrust.com/onetrust/reference/getinventorybyexternalidusingget.md)
* [Get Inventory by ID](https://developer.onetrust.com/onetrust/reference/getinventorybyidusingget.md)
* [Update Inventory by ID](https://developer.onetrust.com/onetrust/reference/updateinventoryusingput.md)
* [Create Inventory](https://developer.onetrust.com/onetrust/reference/createinventoryusingpost.md)
* [Update Inventory by External ID](https://developer.onetrust.com/onetrust/reference/upsertinventoryusingput.md)
* [Delete Inventory](https://developer.onetrust.com/onetrust/reference/deleteinventoryusingdelete.md)
* [Copy Inventory](https://developer.onetrust.com/onetrust/reference/copyinventoryusingpost.md)