Skip to content

Cancel User

Lee Sambridge edited this page May 29, 2024 · 12 revisions

Cancel user

To cancel a user use the following endpoint and json fields must be specified to identify the user that should be cancelled.

Cancel user By User Id

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

HTTP Response Values

    HTTP - 200 - Successful cancellation of a new user
    HTTP - 400 - The user could not be cancelled
    HTTP - 404 - User Id supplied could not be found
Route Parameter Description
memberId User's Id, can be retrieved from look up Apis - Required

A successful response looks like:

{
    "ResultDetails": "User subscription cancelled successfully",
    "MemberUrl": "200-OK",
    "User": {
        "RenewalDate": "2025-05-27",
        "API": "Members",
        "JoinDate": "2024-05-28",
        "loginUrl": "",
        "level": "Basic",
        "LastName": "lastName",
        "Status": "Cancelled",
        "FirstName": "FirstName",
        "EmailAddress": "ytkxlpbkzjkqhy38voo4@endurancezone.com_cancelled",
        "Id": 15140134
    }
}

Clone this wiki locally