Exclusive 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

Copy
{
    isCompanyRoleNameAvailable(
        name: String!
    ) {
        is_role_name_available
    }
}
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:

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

Response:

Copy
{
  "data": {
    "isCompanyRoleNameAvailable": {
      "is_role_name_available": false
    }
  }
}
Copied to your clipboard
{
  "data": {
    "isCompanyRoleNameAvailable": {
      "is_role_name_available": false
    }
  }
}

Last updated 5/7/2025

Was this helpful?

Yes

No