businessUnitAssociateDeactivate

Mutationin Business units

Deactivate an associate so they can no longer act within the business unit. Their roles are preserved for reactivation. Cannot deactivate the last active administrator. Idempotent when already inactive.

Arguments

Argument	Type	Description
businessUnitId	ID!
customerId	ID!

Returns

BusinessUnitAssociateStatusUpdateResponse!

Field	Type	Description
businessUnit	BusinessUnit	Updated business unit information with the modified associate status
businessUnitErrors	[BusinessUnitAssociateStatusUpdateError!]	Error details if the associate status update failed

Example

Query

mutation {
  businessUnitAssociateDeactivate(
    businessUnitId: "bu-123"
    customerId: "customer-456"
  ) {
    businessUnit {
      id
      associates {
        items {
          id
          status
        }
      }
    }
    businessUnitErrors {
      ... on ValidationError {
        message
      }
    }
  }
}

Response

{
  "data": {
    "businessUnitAssociateDeactivate": {
      "businessUnit": {
        "id": "id-1",
        "associates": {
          "items": [
            {
              "id": "id-1",
              "status": "ACTIVE"
            }
          ]
        }
      },
      "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	Not resolved