Skip to content

Commit 84d74dd

Browse files
committed
add private beta alert
1 parent 792c936 commit 84d74dd

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

src/unify/identity-resolution/delete-profile-identifier-api.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ The Delete Profile Identifier API removes identifiers from a profile while prese
88

99
Use this API to clean up outdated or incorrectly added identifiers without deleting entire profiles and replaying events.
1010

11+
This page explains how to use the API, including how deletions work across Segment systems and what to consider before you begin.
12+
13+
> info "Delete Profile Identifier API Private Beta"
14+
> The Delete Profile Identifier API is in Private Beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
15+
1116
## Use cases
1217

1318
The Delete Profile Identifier API helps you clean up identifiers that shouldn't be associated with a profile, including:
@@ -20,15 +25,18 @@ The Delete Profile Identifier API helps you clean up identifiers that shouldn't
2025

2126
## Before you begin
2227

23-
The Delete Profile Identifier API is available to Unify and Engage customers during private beta.
28+
> warning "Deletion scope"
29+
> This API removes identifiers from Unify systems only. For complete user data deletion across all Segment systems (required for GDPR, CCPA, and other privacy regulations), see [Segment's user deletion and suppression guidance](/docs/privacy/user-deletion-and-suppression/).
30+
31+
The Delete Profile Identifier API is available to Unify and Engage customers during private beta.
2432

2533
You need one of these roles to delete identifiers:
2634

2735
- Workspace Owner
2836
- Identity Admin
2937
- Unify and Engage Admin
3038

31-
See [the Roles documentation](/docs/segment-app/iam/roles/) for more details.
39+
See [the Roles documentation](/docs/segment-app/iam/roles/) for more detailss.
3240

3341
If you use [Profiles Sync](/docs/unify/profiles-sync/overview/), you must also:
3442

@@ -138,9 +146,9 @@ The API returns the following HTTP status codes:
138146
| `404` | `source_id_not_found` | No source attached to space_id `<space_id>`. |
139147
| `429` | `rate_limit_error` | Attempted to delete more than 100 IDs per second for a single profile. |
140148

141-
## Limitations and considerations
149+
## Considerations and deletion behavior
142150

143-
<!-- add intro sentence again -->
151+
Keep the following information in mind as you use the Delete Profile Identifier API.
144152

145153
### Deletion scope
146154

@@ -156,21 +164,21 @@ Segment allows up to 100 deletion requests per second per space and 100 deletion
156164

157165
Most deletion requests complete in under 3 seconds. Deletions on profiles with more than 15 merges or 50 identifier mappings may take longer.
158166

159-
Deletion propagates to connected systems at different speeds:
167+
Deletion syncs to connected systems at different speeds:
160168

161-
- **Real-Time Profile Storage**: seconds to 5 minutes
162-
- **Profile Sync**: depends on your sync schedule
169+
- **Real-time Profile storage**: seconds to 5 minutes
170+
- **Profiles Sync**: depends on your sync schedule
163171

164172
### Space rebuilds and replays
165173

166174
If you rebuild a space from Segment Archives, deletions don't replay automatically. You must rerun deletions after the replay completes.
167175

168176
### Identifier reintroduction
169177

170-
Segment may reintroduce deleted identifiers in the following cases:
178+
Segment may reintroduce deleted identifiers in these limited cases:
171179

172-
1. **Event replays**: Replaying events from the Event Archive that reference deleted identifiers adds them back to the profile.
173-
2. **Engage or Journey sync timing**: Deleting an identifier within 5 minutes of sending an event that references it may result in the identifier being reintroduced through Engage-generated events.
180+
- **Event replays**: Replaying events from the Event Archive that reference deleted identifiers adds them back to the profile.
181+
- **Engage or Journey sync timing**: Deleting an identifier within 5 minutes of sending an event that references it may result in the identifier being reintroduced through Engage-generated events.
174182

175183
### Profile API source
176184

0 commit comments

Comments
 (0)