Skip to content

Update readme to document permanent deletion and rename old delete method to archive #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
choran merged 2 commits into from
Oct 1, 2018
Merged

Update readme to document permanent deletion and rename old delete method to archive #228

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
006c91f
Update readme to document permanent deletion and rename old delete me…
Sep 28, 2018
13f2d19
Merge branch 'master' into timlim/update-readme-permanently-delete-user
choran Oct 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,19 +167,22 @@ ScrollableUserCollection usersScroll = User.scroll();
List<User> users = usersScroll.getPage();
usersScroll = usersScroll.scroll();

// Delete a user by Intercom ID
// Archive a user by Intercom ID
User user = User.find("541a144b201ebf2ec5000001");
User.delete(user.getId());
User.archive(user.getId());

// Delete a user by user_id
// Archive a user by user_id
Map<String, String> params = Maps.newHashMap();
params.put("user_id", "1");
User.delete(params);
User.archive(params);

// Delete a user by email
// Archive a user by email
Map<String, String> params = Maps.newHashMap();
params.put("email", "malcolm@serenity.io");
User.delete(params);
User.archive(params);

// Permanently delete a user by Intercom ID
User.permanentDelete("541a144b201ebf2ec5000001");
```

### Contacts
Expand Down