search
☰

Preview

deleteAccountMembership is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

deleteAccountMembership

Delete a marketplace user's account (company) membership. If this is the only company the user was member of, the user is marked as deleted. A user who has active entitlements, owns products, or is managed on an external system can't be deleted.

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_CHANNEL_SUPPORT

    ROLE_CORPORATE_ADMIN

    ROLE_PARTNER

    ROLE_RESELLER

    ROLE_SALES_SUPPORT

    ROLE_SYS_ADMIN

    Arguments

    input DeleteAccountMembershipInput! PREVIEW

    Specifies data to identify account (company) membership

    DeleteAccountMembershipInput fields

    accountId ID!

    Unique identifier of the account

    userId ID!

    Unique identifier of the user

    Return Fields

    success Boolean!

    Whether the account membership is deleted successfully

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.