deleteCompanyRole mutation
Magento Commerce for B2B only
The content on this page is for Magento Commerce for B2B only.
Learn more
Use the deleteCompanyRole
mutation to delete a company role by ID.
You can get the role ID with the company
query.
Syntax
1
2
3
4
5
6
7
mutation {
deleteCompanyRole(
id: ID!
) {
DeleteCompanyRoleOutput
}
}
Example usage
The following example deletes the specified company role.
Request:
1
2
3
4
5
6
7
mutation {
deleteCompanyRole(
id: "Mg=="
) {
success
}
}
Response:
1
2
3
4
5
6
7
{
"data": {
"deleteCompanyRole": {
"success": true
}
}
}
Input attributes
The deleteCompanyRole
mutation requires the following input:
Attribute | Data Type | Description |
---|---|---|
id |
ID! | The encoded role ID to delete |
Output attributes
The deleteCompanyRole
mutation returns a Boolean value that indicates whether the operation was successful.
Attribute | Data Type | Description |
---|---|---|
success |
Boolean | Indicates whether the company role has been deleted successfully (true or false ) |