Delete a user

Delete a user in Advocate. By default this endpoint only deletes a User on an Account (and not the Account itself).

To delete both the Account (and all the users on the account), use the Delete Account endpoint.

Learn more about deleting participants within Advocate in our article on Participant Deletion.

Include the doNotTrack query parameter as true to indicate to Advocate that the user should not be able to be re-registered on the same account. Learn more about doNotTrack in our article on Participant Deletion.

Include the preserveEmptyAccount query parameter as false to indicate to Advocate that the user's account should be deleted if there are no other users in the account.

Log in to see full request history
Path Params
string
required

Tenant being referenced. E.g. "aboih12h16t" or "test_abo912126tastastt"

string
required

The ID of the account to be deleted

string
required

The ID of the user to be deleted

Query Params
boolean

Do not track this user (this user cannot be re-registered in Advocate on the same account), false by default. Learn more about doNotTrack in our article on Participant Deletion

boolean

Do not delete accounts when all the users in the account are deleted, true by default

Responses
204

User successfully deleted

Language
Credentials
:
Click Try It! to start a request and see the response here! Or choose an example:
application/json