deleteCompanyTeam mutation

Magento Commerce for B2B only

The content on this page is for Magento Commerce for B2B only. Learn more

Use the deleteCompanyTeam mutation to delete a company team by ID. You can get the team ID with the company query.

Syntax

1
2
3
4
5
6
7
mutation {
    deleteCompanyTeam(
        id: ID!
    ) {
        DeleteCompanyTeamOutput
    }
}

Example usage

The following example deletes the specified team.

Request:

1
2
3
4
5
6
7
mutation {
  deleteCompanyTeam(
    id: "Mg=="
  ) {
    success
  }
}

Response:

1
2
3
4
5
6
7
{
  "data": {
    "deleteCompanyTeam": {
      "success": true
    }
  }
}

Input attributes

The deleteCompanyTeam mutation requires the following input:

Attribute Data Type Description
id ID! The encoded team ID to delete

Output attributes

The deleteCompanyTeam mutation returns a Boolean value that indicates whether the operation was successful.

Attribute Data Type Description
success Boolean Indicates whether the company team has been deleted successfully (true or false)