Skip to main content

companyAddressDelete

Delete a company address permanently from the system.

Removes the specified address from the company's account. This action cannot be undone. Returns true if deletion was successful.

Possible errors:

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

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

companyAddressDelete(
  input: CompanyAddressDeleteInput!
): Boolean!

Arguments​

companyAddressDelete.input ● CompanyAddressDeleteInput! non-null input​

Company address deletion data including address and company identifiers.

Contains both address ID and company ID to ensure proper ownership validation before deletion.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.