updateAddress

Requires a customer (portal or buyer app) session.

Update editable fields on an address owned by the buyer.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateAddress($input: UpdateMobileAddressInput!) {
  updateAddress(input: $input)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateAddress($input: UpdateMobileAddressInput!) {\n  updateAddress(input: $input)\n}",
  "variables": {
    "input": {
      "addressId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "addressId": "id"
  }
}

Response:

{
  "data": {
    "updateAddress": true
  }
}

updateAddress(
  input: UpdateMobileAddressInput!
): Boolean!

Arguments

updateAddress.input ● UpdateMobileAddressInput! non-null input

The fields of the mobile address to change.

Type

Boolean scalar

The Boolean scalar type represents true or false.