Delete users in the Seller Portal using API

When seller accounts are created, they come with a primary user for basic management. This means the primary user can manage all aspects of the seller account. Larger organizations can have a secondary user to help manage the seller account.

Learn more in our API documentation.

Delete a user

To delete a user, you need to:

• Set up your API client
• Retrieve the User ID
• Delete the user using an API request

Set up your API client

1. Download, install, and open Postman.
2. Go to File > New in the menu bar to open the New window.
3. Select HTTP.
4. Select POST in the request method dropdown.
   
5. Enter your URL (https://[sellername].marketplacer.com/graphql) in the field next to POST.
6. Go to the Authorization tab.
   
7. Select API Key in the Type dropdown.
   
8. Fill in the following values:
   • Key: MARKETPLACER-API-KEY
   • Value: Generate your API key and paste it here. Learn more.
   • Add to: Header
9. Go to the Headers tab. 
10. Fill in the following values in their respective columns:
    • Key: Content-Type
    • Value: application/json

Retrieve the User ID

1. Go to the Body tab.
2. Select GraphQL.
   
3. Enter the following sellerSearch query to get the User ID (Don't forget to change "SELLERNAME" in the query to your seller name):

   • query{
      sellerSearch(attributes: {businessName: "SELLERNAME"}){
       sellers{
        edges{
         node{
          businessName
          users{
           edges{
            node{
             firstName
             userAccountName
             username
             surname
             emailAddress
             id
            }
           }
          }
         }
        }
       }
      }
     }

4. Click Send. 

In the response, look for the user's email address and take note of the User ID.

Delete the user using an API request

1. In the Body tab, replace the query with the following (Don't forget to change "USER ID" in the query to the user ID of the user to be deleted):

   • mutation{
      userDelete( input: {userId: "USER ID"}){
        errors{
         field
         messages
        }
        status
      }
     }

2. Click Send.
3. The user is deleted with the following response: