Skip to main content

UpdateDataHoldV1

A PUT request that updates an existing Data Hold and returns the affected object. The endpoint is https://api.aware.work/external/dataholds/v1/{holdRequestModelId}.

Access​

To access this operation, your API token must have one of the following permissions:

For more information, see the API token documentation.

Request Format​

Parameters​

The endpoint relies on a path parameter, which should be set to the holdRequestModelId of the Data Hold you wish to retrieve. If you do not have an ID, you can query ListDataHoldsV1, filtering on the necessary information.

The remaining parameters below should be included in the JSON body of the request:

ParameterRequiredDescriptionTypeFormat / Options
nameNoThe name you would like to assign to the data hold; if no change is wanted, this can be left out of the requeststring
releaseNoSet this to true in order to deactivate a data hold; if the hold is already inactive, the endpoint returns an error; if no change is wanted, this can be left out of the request or set to falseboolean

Query​

Here is a sample request that can be used to update a Data Hold with the holdRequestModelId of 5e1177db-39c2-ed17-1195-b2e50c242cd0:

curl -X PUT --location "https://api.aware.work/external/dataholds/v1/5e1177db-39c2-ed17-1195-b2e50c242cd0" \
    -H "Content-Type: application/json" \
    -H "X-Aware-Api-Key: ${API_TOKEN}" \
    -d "{
          \"Name\": \"My hold for User - Updated\",
          \"Release\": true
        }"

Response Format​

If the request is successful, the API will return a 200 response and a JSON description of the Data Hold:

{
  "holdRequestModelId": "5e1177db-39c2-ed17-1195-b2e50c242cd0",
  "holdKeyType": "Email",
  "holdKey": "user@example.com",
  "name": "My hold for User - Updated",
  "startedOn": "2023-07-07T01:02:03.0004",
  "stoppedOn": "2023-07-27T01:02:03:0004",
  "platforms": [
    "b8479d5f-4fe6-e2ec-3f10-dfc270f88816"
  ]
}