Skip to main content

addressSetDefault Mutation

Sets a default address for the given user.

Requires MANAGE_USERSpermission.

Triggers the following webhook events:

  • CUSTOMER_UPDATED (async): A customer was updated.
addressSetDefault(
  addressId: ID!
  type: AddressTypeEnum!
  userId: ID!
): AddressSetDefault

Arguments​

addressSetDefault.addressId ● ID! non-null scalar miscellaneous​

ID of the address.

addressSetDefault.type ● AddressTypeEnum! non-null enum miscellaneous​

The type of address.

addressSetDefault.userId ● ID! non-null scalar miscellaneous​

ID of the user to change the address for.

Type​

AddressSetDefault object users​

Sets a default address for the given user.

Requires MANAGE_USERSpermission.

Triggers the following webhook events:

  • CUSTOMER_UPDATED (async): A customer was updated.