Cancel User

Cancel user

To cancel a user use the following endpoint specify the identifier of the user that should be cancelled. The user's status is set to Cancelled and _cancelled is appended to their email address.

[PATCH] /v2/users/{{identifier}}/cancel

HTTP Response Values

    200 - Successful cancellation of the user
    404 - User identifier supplied could not be found, or the user could not be cancelled (the response body text is ```400- NOT OK```)

Route Parameter	Description
identifier	User's identifier, can be retrieved from look up Apis - Required

A successful response looks like:

{
    "RenewalDate": "2027-05-26",
    "API": "Members",
    "JoinDate": "2026-05-27",
    "LoginUrl": "",
    "HubLoginUrl": null,
    "Level": "Basic",
    "LastName": "LastName",
    "Status": "Cancelled",
    "FirstName": "FirstName",
    "EmailAddress": "test@ez-loyalty.com_cancelled",
    "Identifier": 15140131,
    "ExternalMemberId": null,
    "OrgUnits": null,
    "Action": null
}