PUT api/Membership/CancelMembership/{membershipNumber}/{membershipType}/{personRef}

Allows a membership to be cancelled for a customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
membershipNumber

Membership number of the membership to be cancelled.

 string

Required
membershipType

The name of the membership to be cancelled.

 string

Required
personRef

The person reference of the member whose memberships should be cancelled.

 string

Required

Body Parameters

A list of membership joints who have to be cancelled from the membership, if any exist.

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
[{"ID":0,"MemberNumber":"12345678","Title":"Mr","FirstName":"Test","LastName":"Test","PersonRef":"87654321","CreatedOn":"2025-05-10T00:10:04.3941568+01:00"}]

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<APIMembershipJoints xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <APIMembershipJoint>
    <ID>0</ID>
    <MemberNumber>12345678</MemberNumber>
    <Title>Mr</Title>
    <FirstName>Test</FirstName>
    <LastName>Test</LastName>
    <PersonRef>87654321</PersonRef>
    <CreatedOn>2025-05-10T00:10:04.3941568+01:00</CreatedOn>
  </APIMembershipJoint>
</APIMembershipJoints>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"Result":"Success","Message":"Subscription Annual Membership Cancelled for membership number: 01234567"}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<InformationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>Success</Result>
  <Message>Subscription Annual Membership Cancelled for membership number: 01234567</Message>
</InformationResponse>