updateCompanyTeam mutation

Magento Commerce for B2B only

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

Use the updateCompanyTeam mutation to update the company team data.

Syntax

1
2
3
4
5
6
7
mutation {
    updateCompanyTeam(
        input: CompanyTeamUpdateInput!
    ) {
        UpdateCompanyTeamOutput
    }
}

Example usage

The following example updates the name and description of a company team.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
mutation {
  updateCompanyTeam(
    input: {
      name: "My Test Team"
      description: "My Test Team description"
      id: "MQ=="
    }
  ) {
    team {
      id
      name
      description
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
{
  "data": {
    "updateCompanyTeam": {
      "team": {
        "id": "MQ==",
        "name": "My Test Team",
        "description": "My Test Team description"
      }
    }
  }
}

Input attributes

The CompanyTeamUpdateInput input object defines the company team data.

CompanyTeamUpdateInput attributes

The CompanyTeamUpdateInput object contains the following attributes:

Attribute Data Type Description
description String An optional description of the team
id ID! The unique ID for a CompanyTeam object
name String The display name of the team

You can get the team ID with the company query.

Output attributes

The UpdateCompanyTeamOutput output object contains the following attribute:

Attribute Data Type Description
team CompanyTeam! Contains company team data

CompanyTeam attributes

The CompanyTeam object contains details about a company team. It contains the following attributes.

Attribute Data Type Description
description String An optional description of the team
id ID! The unique ID for a CompanyTeam object
name String The display name of the team