Exclusive feature only in Adobe Commerce (Learn more)

deleteCompanyUser mutation

Use the deleteCompanyUser mutation to deactivate the specified company user.

You can get the user ID with the company query.

This mutation requires a valid customer authentication token.

Syntax

Copy
mutation {
    deleteCompanyUser(
        id: ID!
    ) {
        DeleteCompanyUserOutput
    }
}
Copied to your clipboard
mutation {
    deleteCompanyUser(
        id: ID!
    ) {
        DeleteCompanyUserOutput
    }
}

Reference

The deleteCompanyUser reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example deactivates the user specified in the id attribute.

Request:

Copy
mutation {
  deleteCompanyUser(
    id: "Mg=="
  ) {
    success
  }
}
Copied to your clipboard
mutation {
  deleteCompanyUser(
    id: "Mg=="
  ) {
    success
  }
}

Response:

Copy
{
  "data": {
    "deleteCompanyUser": {
      "success": true
    }
  }
}
Copied to your clipboard
{
  "data": {
    "deleteCompanyUser": {
      "success": true
    }
  }
}

Errors

Last updated 5/13/2025

Was this helpful?

Yes

No