Skip to content

Commit 672d576

Browse files
thewheatchoran
authored andcommitted
Update readme to document permanent deletion and rename old delete method to archive (#228)
1 parent fb068de commit 672d576

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,19 +167,22 @@ ScrollableUserCollection usersScroll = User.scroll();
167167
List<User> users = usersScroll.getPage();
168168
usersScroll = usersScroll.scroll();
169169

170-
// Delete a user by Intercom ID
170+
// Archive a user by Intercom ID
171171
User user = User.find("541a144b201ebf2ec5000001");
172-
User.delete(user.getId());
172+
User.archive(user.getId());
173173

174-
// Delete a user by user_id
174+
// Archive a user by user_id
175175
Map<String, String> params = Maps.newHashMap();
176176
params.put("user_id", "1");
177-
User.delete(params);
177+
User.archive(params);
178178

179-
// Delete a user by email
179+
// Archive a user by email
180180
Map<String, String> params = Maps.newHashMap();
181181
params.put("email", "[email protected]");
182-
User.delete(params);
182+
User.archive(params);
183+
184+
// Permanently delete a user by Intercom ID
185+
User.permanentDelete("541a144b201ebf2ec5000001");
183186
```
184187

185188
### Contacts

0 commit comments

Comments
 (0)