Cancel User

Cancel user

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

[POST] /v2/users/Cancel

HTTP Response Values

    HTTP - 200 - Succesfull creation of a new user
    HTTP - 400 - The payload sent is not correct or valid
    HTTP - 404 - Either the email address or the Partner User Id used could not be found

Canceling a membership by POSTINGing to the following JSON body to the endpoint:

{
    "EmailAddress": "email@emai.com",
    "PartnerMemberId" : ID
}

Field	Description
EmailAddress	User's email address
PartnerMemberId	Your unique identifier for this user

A successful response looks like:

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

Cancel user By User Id

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

HTTP Response Values

    HTTP - 200 - Successful creation 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",
        "MemberURL": "",
        "MemberLevel": "Basic",
        "LastName": "YtKxlpbKzjkqHy38VoO4",
        "Status": "Cancelled",
        "FirstName": "YtKxlpbKzjkqHy38VoO4",
        "EmailAddress": "ytkxlpbkzjkqhy38voo4@endurancezone.com_cancelled",
        "Id": 15140134
    }
}