Newer Version Available

This content describes an older version of this product. View Latest

ConsentUnsubscribeAllEvent

Notifies subscribers when a user unsubscribes from all communications on a preference form created in Preference Manager. This object is available in API version 60.0 and later.

Supported Calls

create(), describeSObjects()

Supported Subscribers

Subscriber Supported?
Apex Triggers Yes
Flows Yes
Processes Yes
Pub/Sub API Yes
Streaming API (CometD) Yes

Subscription Channel

/event/ConsentUnsubscribeAllEvent

Event Delivery Allocation Enforced

Yes

Special Access Rules

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

Fields

Field Details
EventDetails
Type
textarea
Properties
Create
Description
JSON text that contains the details for the unsubscribe all event, such as the timestamp for when the event happened.
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message.
ReplayId
Type
string
Properties
Nillable
Description
Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.