Disable a membership

You might need to disable an account member from accessing the account. Disabling a membership doesn't require consent.

Note that you can also suspend account memberships and resume access for suspended account memberships. Learn more in the guide to suspend and resume account memberships.

Prerequisites

You can't disable the legal representative's account membership. If needed, change the account's legal representative before disabling the membership.

Web Banking

Your users can disable account memberships from Swan's Web Banking interface.

Guide

1. Call the disableAccountMembership mutation.
2. Add the account membership ID.
3. Add the success payload with the status.
4. Add any rejections you'd like.

Mutation

🔎 Open the mutation in API Explorer

mutation DisableMembership {
  disableAccountMembership(
    input: { accountMembershipId: "$ACCOUNT_MEMBERSHIP_ID" }
  ) {
    ... on DisableAccountMembershipSuccessPayload {
      __typename
      accountMembership {
        statusInfo {
          status
        }
        updatedAt
      }
    }
  }
}

Payload

The payload shows that the account membership is Disabled.

{
  "data": {
    "disableAccountMembership": {
      "__typename": "DisableAccountMembershipSuccessPayload",
      "accountMembership": {
        "statusInfo": {
          "status": "Disabled"
        },
        "updatedAt": "2023-06-01T12:59:12.763Z"
      }
    }
  }
}