Skip to main content

externalAddressUpdate

DEPRECATED

External addresses are deprecated and will be removed in a future version.

Update an existing external address with new information (deprecated).

Modifies external address details for legacy integrations. This functionality is deprecated and will be removed in future versions.

Possible errors:

  • ADDRESS_UPDATE_ERROR: Failed to update the external address in the backend service
  • ADDRESS_UNKNOWN_ERROR: Unknown error occurred during external address update
  • FORBIDDEN: Insufficient permissions to update external addresses

AUTH: Role=[configuration.OWNER,configuration.EDITOR] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

externalAddressUpdate(
  input: ExternalAddressUpdateInput!
): ExternalAddress! @deprecated

Arguments​

externalAddressUpdate.input ● ExternalAddressUpdateInput! non-null input​

External address update data including address ID and modified fields.

Contains address ID and any fields to be updated. Only provided fields will be modified.

Type​

ExternalAddress object​

External address entity for legacy integrations (deprecated).

Represents address data for external systems without type, default status, or active status fields. This functionality is deprecated and will be removed in future versions.