Anchor to section titled 'undefined'

customerDefaultAddressUpdate
mutation

Requires unauthenticated_write_customers access scope.

Updates the default address of an existing customer.

Anchor to section titled 'Arguments'

Arguments

Anchor to addressId
addressId
ID!
required

ID of the address to set as the new default for the customer.

Anchor to customerAccessToken
customerAccessToken
String!
required

The access token used to identify the customer.

Was this section helpful?
Anchor to section titled 'CustomerDefaultAddressUpdatePayload returns'

CustomerDefaultAddressUpdatePayload returns

Anchor to CustomerDefaultAddressUpdatePayload.customer
customer
Customer

The updated customer object.

Anchor to CustomerDefaultAddressUpdatePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CustomerDefaultAddressUpdatePayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use customerUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerDefaultAddressUpdate($addressId: ID!, $customerAccessToken: String!) {
  customerDefaultAddressUpdate(addressId: $addressId, customerAccessToken: $customerAccessToken) {
    customer {
      # Customer fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "addressId": "gid://shopify/<objectName>/10079785100",
  "customerAccessToken": "<your-customerAccessToken>"
}