Identity API \ Delete an identity PHP SDK

Send a DELETE request to this resource in order to delete an identity. This operation cannot be undone.

Resource/URI - Common GET POST PUT DELETE
Identities /identities.json List all identities
Identity /identities/<identity_token>.json Read identity details Delete identity
Identity /identities/<identity_token>/link.json ReLink identity
Identity /identities/<identity_token>/synchronize.json Synchronize identity
Identity /identities/<identity_token>/contacts.json Read identity contacts
Resource/URI - Provider Specific Complete Plus Data GET POST PUT DELETE
Steam Games /identities/<identity_token>/steam/games.json List all Steam games
YouTube Videos /identities/<identity_token>/youtube/videos.json List all YouTube videos
Facebook Posts /identities/<identity_token>/facebook/posts.json List all Facebook posts

Workflow

Request: the code to send to the API

Send a DELETE request to the resource /identities/<identity_token>.json to immediately delete an identity. The <identity_token> has to be replaced by the unique token of an existing identity.

To prevent you from unintentionally deleting an entry by mixing up the DELETE/GET methods you have to include the url parameter confirm_deletion=true in your DELETE requests. If you omit this parameter, the entry will not be removed and an error will be thrown.

Result: the code returned by the API

The API will either return a HTTP status code 200 if the entry was sucessfully deleted or an appropriate message body with further details on the error that occured.

User Contributed Notes