Skip to content

Commit a695732

Browse files
pwsegpwseg
committed
explain request better
1 parent c79fb27 commit a695732

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

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

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,18 @@ If you use [Profiles Sync](/docs/unify/profiles-sync/overview/), you must also:
3939

4040
## How deletion works
4141

42-
When you delete an identifier, Segment removes it from [Identity Resolution](/docs/unify/identity-resolution/) and propagates the change through connected systems. <!-- I don't like propagates-->
42+
When you delete an identifier, Segment removes it from [Identity Resolution](/docs/unify/identity-resolution/) and syncs the change to connected systems.
4343

44-
After you send the request, the Delete Profile Identifier API confirms that Segment deleted the identifier from the Real-Time Identity Graph. Deletion then propagates to other systems:
44+
The API confirms that Segment deleted the identifier from the Real-Time Identity Graph. The deletion then flows through these systems:
4545

46-
1. Real-time Profile storage**: The Profile API and Profile explorer delete the identifier in near real time.
47-
2. Batch Profile Data lakehouse: Segment soft-deletes the identifier (flags it as deleted) in the append-only table within minutes. The identifier filters out from the materialized view within 24 hours.
48-
3. Customer data warehouse: Profile Sync sends a deletion notification to your warehouse. The `external_id_mapping_updates` table shows the identifier with `__operation` set to `REMOVED`. The `user_identifiers` materialized view filters out removed identifiers.
46+
| System | What happens |
47+
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
48+
| Real-time Profile storage | The Profile API and Profile explorer delete the identifier in near real time |
49+
| Batch Profile Data lakehouse | Segment soft-deletes the identifier in the append-only table within minutes and filters it from the materialized view within 24 hours |
50+
| Customer data warehouse | Profiles Sync adds a row to `external_id_mapping_updates` with `__operation` set to `REMOVED`. The `user_identifiers` view filters out removed identifiers |
4951

50-
<!-- maybe come back and turn this into a table?-->
5152

52-
## Delete an identifier <!-- maybe think of a better header-->
53+
## Send a deletion request
5354

5455
You can only delete identifiers from known profiles. The API requires a valid `user_id` to locate the profile.
5556

@@ -62,35 +63,28 @@ The API returns an error if you try to delete:
6263

6364
The API accepts one identifier per request.
6465

65-
**Endpoint**:
66-
```sh
67-
POST https://{HOST_NAME}/v1/spaces/{SPACE_ID}/collections/users/profiles/user_id:{USER_ID_VALUE}/external_ids/delete
68-
```
66+
Send requests to this endpoint:
6967

70-
```sh
71-
https://{HOST_NAME}/v1/spaces/{SPACE_ID}/collections/users/profiles/user_id:{USER_ID_VALUE}/external_ids/delete
68+
```
69+
POST https://{HOST_NAME}/v1/spaces/{SPACE_ID}/collections/users/profiles/user_id:{USER_ID_VALUE}/external_ids/delete
7270
```
7371

74-
`POST https://{HOST_NAME}/v1/spaces/{SPACE_ID}/collections/users/profiles/user_id:{USER_ID_VALUE}/external_ids/delete`
75-
76-
**Parameters**:
77-
78-
| Parameter | Description |
79-
| ----------------- | ---------------------------------------------------------------------------------------------------- |
80-
| **HOST_NAME** | `profiles.segment.com` for North America workspaces or `profiles.euw1.segment.com` for EU workspaces |
81-
| **SPACE_ID** | Your space ID. Find this in **Unify > Unify settings > API access** |
82-
| **USER_ID_VALUE** | The `user_id` value that identifies the profile |
83-
| **AUTH_TOKEN** | Your access token. Generate this in **Unify > Settings > API access** |
72+
Replace the following parameters in the URL:
8473

85-
**Request body**:
74+
| Parameter | Description |
75+
| --------------- | ---------------------------------------------------------------------------------------------------- |
76+
| `HOST_NAME` | `profiles.segment.com` for North America workspaces or `profiles.euw1.segment.com` for EU workspaces |
77+
| `SPACE_ID` | Your space ID. Find this in **Unify > Unify settings > API access**. |
78+
| `USER_ID_VALUE` | The `user_id` value that identifies the profile. |
79+
| `AUTH_TOKEN` | Your access token. Generate this in **Unify > Unify settings > API access**. |
8680

87-
| Field | Description |
88-
| ----------------------- | ------------------------------------------------------------------------------ |
89-
| **delete_external_ids** | Array containing the identifier to delete. Limit: 1 identifier per request |
90-
| **id** | Value of the identifier to delete (for example, `hello@gmail.com`) |
91-
| **type** | Type of identifier to delete (for example, `email`, `anonymous_id`, `user_id`) |
81+
Include these fields in the request body:
9282

93-
<!--change parameters to code styling, add intros between table headers -->
83+
| Field | Description |
84+
| --------------------- | ------------------------------------------------------------------------------ |
85+
| `delete_external_ids` | Array containing the identifier to delete. Limit: 1 identifier per request |
86+
| `id` | Value of the identifier to delete (for example, `hello@gmail.com`) |
87+
| `type` | Type of identifier to delete (for example, `email`, `anonymous_id`, `user_id`) |
9488

9589
### Example request
9690

0 commit comments

Comments
 (0)