data-src=../../../../../includes/commerce-only.md

updateCompanyAddress mutation

data-variant=info

data-slots=text1

The updateCompanyAddress mutation allows a company admin or user who is assigned a role that contains the Magento_CompanyAddressStorefrontCompatibility::edit permission to update an existing company address.

This mutation requires a valid customer authentication token.

Syntax

mutation {
    updateCompanyAddress(
        id: ID!
        input: CompanyAddressInput!
    ) {
        CompanyAddress
    }
}

Example usage

Update a company address

The following example updates an existing company address.

Request:

mutation UpdateCompanyAddress {
    updateCompanyAddress(
        id: "MTI="
        input: {
            nickname: "Updated Nickname"
            address_type: BILLING
            is_default: false
            firstname: "Jane"
            lastname: "Smith"
            company: "Updated Corp"
            street: ["456 Oak Ave"]
            city: "Dallas"
            country_code: US
            region: {
                region_id: 57
                region: "Texas"
                region_code: "TX"
            }
            postcode: "75201"
            telephone: "5559876543"
        }
    ) {
        id
        nickname
        address_type
        is_default
        firstname
        lastname
        company
        city
        street
        country_code
        postcode
        telephone
    }
}

Response:

{
  "data": {
    "updateCompanyAddress": {
      "id": "MTI=",
      "nickname": "Updated Nickname",
      "address_type": "BILLING",
      "is_default": false,
      "firstname": "Jane",
      "lastname": "Smith",
      "company": "Updated Corp",
      "city": "Dallas",
      "street": ["456 Oak Ave"],
      "country_code": "US",
      "postcode": "75201",
      "telephone": "5559876543"
    }
  }
}

Clearing default via is_default: false on an address that is currently default requires set-default ACL (same as setDefaultCompanyAddress).