---
schema_version: "1"
id: ecefd2a278aaed4bf5d40791a670d7790cacb26bc8bf7fda8278873655acd438
title: PrivacyHold
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_privacyhold.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_privacyhold.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 9f54f06a305a956d0665a3640a79c6a5c9bc88890f5d3f69cb1d425d68f0a8a2
description: Represents a Privacy Hold that indicates that a record should be preserved from masking or deletion by Data Management policies in Privacy Center. This object is available in API version 59.0 and later.
---
# PrivacyHold

Represents a Privacy Hold that indicates that a record should be preserved from masking or deletion by Data Management policies in Privacy Center. This object is available in API version 59.0 and later.

Use Privacy Hold with Data Management policies in Privacy Center. Add a condition to your policy to exclude records with an active Privacy Hold status from masking or deletion actions.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Special Access Rules

This object is available for users with the Privacy Center license and the Manage Privacy Hold user permission.

## Fields

| Field | Details |
| --- | --- |
| EndDate | 
Type

date

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The date the Privacy Hold ends.



 |
| IsActive | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates if Privacy Hold is active on the record.

The default value is false.



 |
| LastReferencedDate | 

Type

dateTime

Properties

Filter, Nillable, Sort

Description

The timestamp for when the current user last viewed a record related to this record.



 |
| LastViewedDate | 

Type

dateTime

Properties

Filter, Nillable, Sort

Description

The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.



 |
| Name | 

Type

string

Properties

Create, Filter, Group, idLookup, Sort, Update

Description

The name of the Privacy Hold.



 |
| OwnerId | 

Type

reference

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

The ID of the owner of the account associated with this customer.

This field is a polymorphic relationship field.

Relationship Name

Owner

Relationship Type

Lookup

Refers To

Group, User



 |
| PrivacyHoldReasonId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The ID of the associated Privacy Hold Reason.

This field is a relationship field.

Relationship Name

PrivacyHoldReason

Relationship Type

Lookup

Refers To

PrivacyHoldReason



 |
| ReferenceRecordId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The ID of the record marked for the Privacy Hold.

This field is a polymorphic relationship field.

Relationship Name

ReferenceRecord

Relationship Type

Lookup

Refers To

Account, Contact, Individual, Lead, User



 |
| ReferenceRecordType | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

The type of object the record with the Privacy Hold is associated with.

Possible values are:

- Account
- Contact
- Individual
- Lead
- User





 |
| RegisteredDate | 

Type

date

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The date the Privacy Hold was added to the record.



 |