Skip to main content

externalAddressDelete

DEPRECATED

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

Delete an external address permanently from the system (deprecated).

Removes the specified external address for legacy integrations. This functionality is deprecated and will be removed in future versions. Returns true if deletion was successful.

Possible errors:

  • ADDRESS_DELETE_ERROR: Failed to delete the external address in the backend service
  • ADDRESS_UNKNOWN_ERROR: Unknown error occurred during external address deletion
  • FORBIDDEN: Insufficient permissions to delete external addresses

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

externalAddressDelete(
  input: ExternalAddressDeleteInput!
): Boolean! @deprecated

Arguments​

externalAddressDelete.input ● ExternalAddressDeleteInput! non-null input​

External address deletion data including address identifier.

Contains the address ID to be deleted from the external address system.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.