businessUnitAssociateInvite

Mutationin Business units

Invite a new associate to the business unit with specified roles

Arguments

Argument	Type	Description
businessUnitId	ID!
email	String!
roleIds	[ID!]!

Returns

BusinessUnitAssociateInviteResponse!

Field	Type	Description
businessUnit	BusinessUnit	Updated business unit information with new associate
businessUnitErrors	[BusinessUnitAssociateInviteError!]	Error details if associate invitation failed

Example

Query

mutation {
  businessUnitAssociateInvite(
    businessUnitId: "bu-123"
    email: "new.associate@company.com"
    roleIds: ["role-admin", "role-buyer"]
  ) {
    businessUnit {
      id
      associates {
        items {
          id
          email
          roles {
            id
            name
          }
        }
      }
    }
    businessUnitErrors {
      ... on ValidationError {
        message
      }
    }
  }
}

Response

{
  "data": {
    "businessUnitAssociateInvite": {
      "businessUnit": {
        "id": "id-1",
        "associates": {
          "items": [
            {
              "id": "id-1",
              "email": "jane@example.com",
              "roles": [
                {
                  "id": "id-1",
                  "name": "Example"
                }
              ]
            }
          ]
        }
      },
      "businessUnitErrors": [
        {
          "message": "Example"
        }
      ]
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Stub: answers Not implemented

Used by

The storefront packages that send it, in these GraphQL documents:

• @evolve-storefront/feature-organization: BusinessUnitAssociateInvite