Skip to content

Commit bccff88

Browse files
committed
Update user-deletion-and-suppression.md
1 parent 8188078 commit bccff88

File tree

1 file changed

+74
-83
lines changed

1 file changed

+74
-83
lines changed
Lines changed: 74 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,123 +1,108 @@
11
---
2-
title: "User Deletion and Suppression"
2+
title: User Deletion and Suppression
33
---
44

5-
In keeping with Segment's commitment to GDPR and CCPA readiness, Segment offers the ability to delete and suppress data about end-users when they are identifiable by a `userId`, should they revoke or alter consent to data collection. For example, if an end-user invokes the Right to Object or Right to Erasure under the GDPR or CCPA, you can use these features to block ongoing data collection about that user and delete all historical data about them from Segment's systems, connected S3 buckets and warehouses, and supported downstream partners.
5+
Segment offers you the ability to delete and suppress data about your end-users when they are identifiable by a `userId` to support your compliance with privacy regulations like the GDPR and CCPA. For example, if your end-user invokes the Right to Object or Right to be Forgotten, you can block ongoing data collection about that user and delete all historical data about them from Segments systems, any of your connected warehouses or S3 buckets, and some supported downstream partners.
66

7-
[Contact Support](https://segment.com/help/contact/) if you need to process more than 110,000 users within a 30 day period.
8-
9-
> info "Business Plan Customers"
7+
> info "Business Plan Customers"
108
> If you use this feature to delete data, you can not Replay the deleted data. For standard Replay requests, you must wait for any pending deletions to complete, and you cannot submit new deletion requests for the period of time that Segment replays data for you.
119
12-
> info ""
13-
> The legacy GraphQL APIs for user deletion and suppression are deprecated. Instead, use the [Segment Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} to interact with the User Deletion and Suppression system.
10+
## Regulations
1411

15-
## Overview
12+
All deletion and suppression actions in Segment are asynchronous and categorized as Regulations, or requests to Segment to control your data flow. You can issue Regulations from:
1613

17-
All deletion and suppression actions in Segment are asynchronous and categorized as Regulations. Regulations are requests to Segment to control your data flow. You can issue Regulations from:
18-
- Your Segment Workspace (Settings > End User Privacy)
19-
- [Segment's Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"}
14+
- Your Segment Workspace (**Settings > End User Privacy**)
15+
- [Segment's Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"}. You can delete up to 5000 `userId`s per call using the Public API.
2016

21-
You can programmatically interact with the User Deletion and Suppression system using the [Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"}.
17+
With Regulations, you can issue a single request to delete and suppress data about a user by `userId`. Segment scopes Regulations to your workspace (which targets all sources within the workspace).
2218

23-
With Regulations, you can issue a single request to delete and suppress data about a user by `userId`. Segment scopes Regulations to your workspace (which targets all sources within the workspace), to a specific source, or to a cloud source.
19+
> warning “Data sent to device-mode destinations cannot be suppressed”
20+
> Destinations set up in device mode are sent directly to destinations and bypass the point in the pipeline where Segment suppresses events.
2421
2522
The following regulation types are available:
2623

27-
- **SUPPRESS_ONLY**: Suppress new data without deleting existing data
28-
- **UNSUPPRESS:** Stop an ongoing suppression
29-
- **SUPPRESS_WITH_DELETE:** Suppress new data and delete existing data
30-
- **DELETE_INTERNAL:** Delete data from Segment internals only
31-
- **SUPPRESS_WITH_DELETE_INTERNAL:** Suppress new data and delete from Segment internals only
32-
- **DELETE_ONLY:** Delete existing data without suppressing any new data
24+
- **SUPPRESS_WITH_DELETE_INTERNAL*:** Suppress new data and delete from Segment internal systems only
25+
- **DELETE_INTERNAL*:** Delete data from Segment internal systems only
26+
- **SUPPRESS_ONLY***: Suppress new data without deleting existing data
27+
- **UNSUPPRESS*:** Stop an ongoing suppression
28+
- **SUPPRESS_WITH_DELETE:** Suppress new data and delete existing data
29+
- **DELETE_ONLY:** Delete existing data without suppressing any new data
3330

31+
*To send more than 110,000 SUPPRESS_ONLY, UNSUPRESS, DELETE_INTERNAL and/or SUPPRESS_WITH_DELETE_INTERNAL Regulations over a 30 day period, [contact Segment Support](https://segment.com/help/contact/){:target="_blank"}. Segment can’t increase the limit for SUPPRESS_WITH_DELETE and DELETE_ONLY regulations. Regulations submitted after you’ve hit the 110,000 Regulations in a 30 day period are rate limited.
3432

35-
> info ""
33+
> info ""
3634
> Using **SUPPRESS_WITH_DELETE** or **DELETE_ONLY** regulation types might lead to additional charges levied by your destination providers.
3735
38-
## Suppression Support and the Right to Revoke Consent
39-
40-
`SUPPRESS` regulations add a user to your suppression list by the `userId`. Segment blocks suppressed users across all sources; messages you send to Segment with a suppressed `userId` are blocked at the API. These messages do not appear in the debugger, are not saved in archives and systems, and are not sent to any downstream server-side destinations. However, if you set up a destination in [device-mode](/docs/connections/destinations/#connection-modes), the events are sent directly to destinations as well. In this case, Suppression doesn't suppress the events.
41-
42-
When a customer exercises the right to erasure, they expect that you stop collecting data about them. Suppression regulations ensure that regardless of how you're sending data to Segment, if a user opts out, Segment respects their wishes on an ongoing basis and across applications.
36+
## The Right to be Forgotten and Suppression Support
4337

44-
**Suppression is not a substitute for gathering affirmative, unambiguous consent about data collection and its uses.**
38+
When your customers exercise their Right to be Forgotten, sometimes known as Right to Erasure, they expect you to stop collecting new data and delete all previously collected data from your systems: including Segment and other downstream tools.
4539

4640
Segment offers suppression tools to help you manage the challenge of users opting-out across different channels and platforms. Segment encourages and expects that you design your systems and applications so you don't collect or forward data to Segment until you have unambiguous, specific, informed consent or have established another lawful legal basis to do so.
4741

48-
To remove a user from the suppression list, create an `UNSUPPRESS` regulation.
49-
50-
## Deletion Support and the Right to Be Forgotten
51-
52-
When you create a `SUPPRESS_WITH_DELETE` regulation, the user is actively suppressed, and Segment begins permanently deleting all data associated with this user from your workspace. This includes scanning and removing all messages related to that `userId` from all storage mediums that don't automatically expire data within 30 days, including archives, databases, and intermediary stores.
53-
54-
Segment deletes messages with this `userId` from connected raw data Destinations, including Redshift, BigQuery, Postgres, Snowflake, and Amazon S3. Warehouse deletions occur using a DML run against your cluster or instance, and Segment delete from S3 by "recopying" clean versions of any files in your bucket that included data about that `userId`.
42+
**Suppression is not a substitute for gathering affirmative, unambiguous consent about data collection and its uses.**
5543

56-
Segment forwards these deletion requests to a [growing list of supported partners](/docs/privacy/faq/#which-destinations-can-i-send-deletion-requests-to).
44+
### Suppression support
5745

58-
Note that Segment has a 30-day SLA for submitted deletion requests. Additionally, Segment's deletion manager can only accommodate 110,000 users within a 30-day period and cannot guarantee a 30-day SLA if there are more than 110,000 deletion requests submitted within those 30 days. You can delete up to 5000 `userId`s per call via Public API. [Contact Support](https://segment.com/help/contact/){:target="_blank"} if you need to process more than 110,000 users within a 30 day period.
59-
60-
**Segment cannot guarantee that data is deleted from your Destinations.**
46+
[`SUPPRESS` regulations](#suppress-a-new-user) add a user to your suppression list by the `userId`. Segment blocks suppressed users across all sources, and messages you send to Segment with a suppressed `userId` are blocked at the API. These messages do not appear in the debugger, are not saved in archives and systems, and are not sent to any downstream server-side destinations.
6147

62-
Segment forwards deletion requests to [supported Destinations](/docs/privacy/faq/#which-destinations-can-i-send-deletion-requests-to) (such as Braze, Intercom, and Amplitude) but you should confirm that each partner fulfills the request.
48+
To [remove a user from the suppression list](#remove-a-user-from-the-suppression-list), create an `UNSUPPRESS` regulation.
6349

64-
You will also need to contact any unsupported Destinations separately to manage user data deletion.
50+
##### Suppress a new user
6551

66-
Note that if you later **UNSUPPRESS** a user, the deletion functionality does not clean up data sent after removing the user from the suppression list.
52+
To create a suppression regulation and add a `userId` to this list, click **Suppress New User**, and enter the `userId` in the field that appears. Then click **Request Suppression**.
6753

68-
## Suppressed users
54+
Segment creates a `SUPPRESS` regulation, and adds the `userId` to your suppression list, mostly processed within 24 hours. In some cases, the suppression request can take up to 30 days to process.
6955

70-
The Suppressed Users tab in Segment App (Settings > End User Privacy) allows you to create new Suppression requests and also shows an list of `userId`s which are **actively** being suppressed. It can take a few hours/days for the suppression to become active, depending on the number of requests that are in the queue for your workspace. Once the request is active, Segment blocks data about these users across all sources.
56+
##### Remove a user from the suppression list
7157

72-
Note that list only includes `SUPPRESS_ONLY` regulations. If you created a User Deletion request using UI, you will need to check the **Deletion Requests** tab, as those are `SUPPRESS_WITH_DELETE` regulation types.
58+
To remove a user from the suppression list, click the ellipses (**...**) icon on the `userId` row and click **Remove**.
7359

74-
### Suppress a new user
60+
This creates an `UNSUPPRESS` regulation and removes the `userId` from your suppression list. Segment processes most `UNSUPPRESS` regulations within 24 hours.
7561

76-
To create a suppression regulation and add a `userId` to this list, click **Suppress New User**, and enter the `userId` in the field that appears. Then click **Request Suppression**.
62+
### Suppressed Users
7763

78-
Segment creates a `SUPPRESS` regulation, and adds the `userId` to your suppression list, mostly processed within 24 hours. In some cases, the suppression request can take up to 30 days to process. You can suppress up to 5000 userIds per call through the Public API.
64+
The Suppressed Users tab in Segment App (**Settings > End User Privacy**) allows you to create new Suppression requests and also shows a list of `userId`s which are **actively** being suppressed. It can take a few hours/days for the suppression to become active, depending on the number of requests that are in the queue for your workspace. Once the request is active, Segment blocks data about these users across all sources.
7965

80-
### Remove a user from the suppression list
66+
> info “`SUPPRESS_WITH_DELETE` requests”
67+
> The Suppressed Users tab only includes `SUPPRESS_ONLY` regulations. If you created a User Deletion request using the UI, you will need to check the [**Deletion Requests**](#deletion-requests-tab) tab, as those are `SUPPRESS_WITH_DELETE` regulation types.
8168
82-
To remove a user from the suppression list, click the ellipses (**...**) icon on the `userId` row, and click **Remove**.
69+
## Deletion Support
8370

84-
This creates an `UNSUPPRESS` regulation, and removes the `userId` from your suppression list, mostly processed within 24 hours.
71+
When you create a `SUPPRESS_WITH_DELETE` regulation, the user is actively suppressed, and Segment begins permanently deleting all data associated with this user from your workspace. This includes scanning and removing all messages related to that `userId` from all storage mediums that don't automatically expire data within 30 days, including archives, databases, and intermediary stores.
8572

86-
## Deletion requests
73+
Segment deletes messages with this `userId` from connected raw data Destinations, including Redshift, BigQuery, Postgres, Snowflake, and Amazon S3. Warehouse deletions occur using a DML run against your cluster or instance, and Segment deletes from S3 by "recopying" clean versions of any files in your bucket that included data about that `userId`.
8774

88-
The deletion requests tab shows a log of all regulations with a deletion element along with status. The deletion requests can take up to 30 days to process.
75+
> warning “Connected warehouses deletions”
76+
> Segment will attempt to delete messages with the target `userId` from your connected warehouses for 7 days. If, after 7 days, Segment cannot delete all identified messages from your connected data warehouse, Segment displays a status of `unsuccessful`. If Segment is unable to delete all identified messages, you will be responsible for removing any
8977
90-
In the Segment App (Settings > End User Privacy > Deletion Requests), you can click a userId to view its status in Segment internal systems, and in the connected destinations.
78+
#### Deletion request SLA
9179

92-
The deletion request can have one of the following statuses:
93-
1. `FAILED`
94-
2. `FINISHED`
95-
3. `INITIALIZED`
96-
4. `INVALID`
97-
5. `NOT_SUPPORTED`
98-
6. `PARTIAL_SUCCESS`
99-
7. `RUNNING`
100-
101-
When checking the status of deletion requests using Segment's API, the deletion will report an overall status of all of the deletion processes. As a result, Segment returns a `FAILED` status because of a failure on an unsupported destination, even if the deletion from the Segment Internal Systems and supported destinations were completed successfully.
80+
Segment has a 30-day SLA for completing deletion requests in Segment’s internal stores for deletion requests of fewer than 110,000 users made over 30 days. Your requests will be rate limited If you submit more than 110,000 deletion requests within 30 days.
10281

103-
### Regulate User from a single Source in a Workspace
82+
**This 30-day SLA is limited to only Segment’s internal stores.** Segment cannot guarantee that deletions in your Amazon S3 instance, your connected data warehouse, or other third-party destinations will be completed during that 30-day period.
10483

105-
Refer to [Create Source Regulation](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/createSourceRegulation){:target="_blank"} in the Public API.
84+
Segment forwards your deletion requests to a [growing list of supported partners](/docs/privacy/faq/#which-destinations-can-i-send-deletion-requests-to), but you should confirm that each partner fulfills the request. You will also need to contact any unsupported Destinations separately to manage user data deletion.
10685

107-
### Delete Object from a Cloud Source
86+
> info “Users that you `UNSUPPRESS` after issuing a deletion request may have remaining data”
87+
> If you **UNSUPPRESS** a user after issuing a deletion request for that user, Segment’s deletion functionality does not clean up data sent after removing the user from the suppression list.
10888
109-
Refer to the [Create Cloud Source Regulation](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/createCloudSourceRegulation){:target="_blank"} Public API endpoint.
89+
#### Deletion requests tab
11090

111-
Cloud Sources sync objects to Segment. As a result, Cloud Sources are regulated based on an `objectId` instead of a `userId`.
112-
Before you delete the object from Segment, you should delete it from the upstream system first.
91+
The deletion requests tab shows a log of all regulations with a deletion element along with status. Deletion requests can take up to 30 days to process.
11392

114-
### List Suppressed Users for your Workspace
93+
In the Segment App (Settings > End User Privacy > Deletion Requests), you can click a userId to view its status in Segment internal systems and in the connected destinations.
11594

116-
Refer to [List Suppressions](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listSuppressions){:target="_blank"} method in the Public API.
95+
The deletion request can have one of the following statuses:
11796

118-
### List Deletion Requests for your Workspace
97+
1. `FAILED`
98+
2. `FINISHED`
99+
3. `INITIALIZED`
100+
4. `INVALID`
101+
5. `NOT_SUPPORTED`
102+
6. `PARTIAL_SUCCESS`
103+
7. `RUNNING`
119104

120-
Refer to the [List Regulations from Source](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listRegulationsFromSource){:target="_blank"} Public API method.
105+
When checking the status of deletion requests using Segment's API, the deletion will report an overall status of all of the deletion processes. As a result, Segment returns a `FAILED` status because of a failure on an unsupported destination, even if the deletion from the Segment Internal Systems and supported destinations were completed successfully.
121106

122107
## Data retention
123108

@@ -131,25 +116,31 @@ To change your data retention settings, navigate to **Privacy > Settings > Data
131116

132117
Select the default retention period for the workspace in this setting. This value applies to all sources in the workspace, unless overridden in the [Source-Level Archive Retention Periods](#source-level-archive-retention-periods) setting.
133118

119+
> warning “7 day Retention Periods will be deprecated on March 6, 2025”
120+
> After March 6, you will no longer be able to set your workspace’s retention period to 7 days. All workspaces with 7 day retention periods will be updated to have 14 day retention periods.
121+
134122
You can select from the following Archive Retention time periods:
135123

136-
- 7 days
137-
- 30 days
138-
- 90 days
139-
- 180 days
140-
- 365 days
124+
- 7 days
125+
- 30 days
126+
- 90 days
127+
- 180 days
128+
- 365 days
141129
- Unlimited (**default**)
142130

143131
### Source-Level Archive Retention Periods
144132

133+
> warning “Source-Level Archive Retention Periods will be deprecated on April 15, 2025”
134+
> After April 15, you will no longer be able to override your workspace’s default retention period on a source-by-source basis.
135+
145136
Override the workspace default retention period on a per-source level.
146137

147138
You can select from the following Archive Retention time periods:
148139

149-
- Default (This is the default value you set in the [Workspace Default Archive Retention Period](#workspace-default-archive-retention-period))
150-
- 7 days
151-
- 30 days
152-
- 90 days
153-
- 180 days
154-
- 365 days
140+
- Default (This is the default value you set in the [Workspace Default Archive Retention Period](#workspace-default-archive-retention-period))
141+
- 7 days
142+
- 30 days
143+
- 90 days
144+
- 180 days
145+
- 365 days
155146
- Unlimited

0 commit comments

Comments
 (0)