Edit in GitHubLog an issue
Thanks to Atwix for contributing this topic!
Adobe Commerce featureExclusive feature only in Adobe Commerce (Learn more)

isCompanyRoleNameAvailable query

The isCompanyRoleNameAvailable query checks whether a company role name is valid for creating into a company.

The query returns a false value if the specified role name has already found in a company.

This query requires a valid customer authentication token.

Syntax

Copied to your clipboard
{
isCompanyRoleNameAvailable(
name: String!
) {
is_role_name_available
}
}

Reference

The isCompanyRoleNameAvailable reference provides detailed information about the types and fields defined in this query.

Example usage

The following example checks whether the company role named "Company Admin" can be used to create a new company role.

Request:

Copied to your clipboard
query {
isCompanyRoleNameAvailable(name: "Company Admin") {
is_role_name_available
}
}

Response:

Copied to your clipboard
{
"data": {
"isCompanyRoleNameAvailable": {
"is_role_name_available": false
}
}
}
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2025 Adobe. All rights reserved.