Skip to main content

addressSetDefault Mutation

Sets a default address for the given user.

Requires the MANAGE_USERSpermission.

Triggers the following webhook events:

  • CUSTOMER_UPDATED (async): A customer was updated.
addressSetDefault(
  addressId: ID!
  type: AddressTypeEnum!
  userId: ID!
): AddressSetDefault
Details
type AddressSetDefault {
  user: User
  accountErrors: [AccountError!]! @deprecated
  errors: [AccountError!]!
}

Arguments​

addressId ● ID!​

ID of the address.

type ● AddressTypeEnum!​

The type of address.

userId ● ID!​

ID of the user to change the address for.

Type​

AddressSetDefault​

Sets a default address for the given user.

Requires the MANAGE_USERSpermission.

Triggers the following webhook events:

  • CUSTOMER_UPDATED (async): A customer was updated.